Skip to main content
GET
/
retirements
/
{id}
Retirement
curl --request GET \
  --url https://api.sandbox.isometric.com/registry/v0/retirements/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-client-secret: <x-client-secret>'
{
  "beneficiary": {
    "domain": "isometric.com",
    "id": "<string>",
    "name": "<string>"
  },
  "credit_batch_size_total": {
    "credit_kgs": 123,
    "credits": 123
  },
  "id": "<string>",
  "notes": "<string>",
  "owner": {
    "domain": "isometric.com",
    "id": "<string>",
    "name": "<string>"
  },
  "purposes": [
    "corporate_targets"
  ],
  "retired_at": "2023-11-07T05:31:56Z",
  "url": "<string>"
}

Authorizations

​
Authorization
string
header
required

A JWT Bearer token header for authentication and authorization, in the format Authorization: Bearer <token>

Headers

​
x-client-secret
string
required

A secret token identifying the client connecting to the API

Example:

"Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"

Path Parameters

​
id
string
required

Response

Successful Response

​
beneficiary
Organisation · object
required
​
credit_batch_size_total
CreditQuantity · object
required
​
id
string
required
Required string length: 20 - 37
Examples:

"ret_1FYBH4QDT1S0SVKF"

"ret_1CGV2XADRSBX1CHB"

​
notes
string | null
required
​
owner
Organisation · object
required
​
purposes
enum<string>[]
required
Available options:
corporate_targets,
public_environmental_claims,
insetting,
regulatory_requirement,
other
​
retired_at
string<date-time>
required
​
url
string
required