v2

latestOpenAPI 3.1.02026-08-054181117.0 KB

Retirement

Information about a specific retirement.

get/retirements/{id}

Path parameters

idstring required

Example:ret_1FYBH4QDT1S0SVKF

Headers

x-client-secretstring required

A secret token identifying the client connecting to the API

Example:Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP

A secret token identifying the client connecting to the API

Response

Successful Response

idstring required

retired_atstring date-time required

purposesRetirementPurpose[] required

urlstring required

notesstring nullable required

Example response

{
  "id": "ret_1FYBH4QDT1S0SVKF",
  "beneficiary": {
    "id": "org_1GB56M1ST1S0GVNA",
    "name": "Isometric",
    "domain": "isometric.com"
  },
  "owner": {
    "id": "org_1GB56M1ST1S0GVNA",
    "name": "Isometric",
    "domain": "isometric.com"
  },
  "credit_batch_size_total": {
    "credits": 125.632,
    "credit_kgs": 125632
  }
}