latestOpenAPI 3.0.02026-08-10517386.6 KB

a9f1b102faca

Retirements

Get retirement

This endpoint returns a json object with the retirement information.

get/retirements

Query parameters

idstring required

The ICR id of the retirement.

Headers

x-icr-api-versionstring

API version

Response

createdAtstring date-time required

The date of when this retirement was made

idstring required

The ID of the retirement

isClaimedboolean

Whether this retirement has been claimed - is false if the retirement happened permissionlessly on blockchain and owner has not claimed the retirement on ICR

reasonstring

The reason for the retirement

commentstring

A comment about the retirement

beneficiarystring

The name of the retiree

organizationIdstring required

The ID of the organization associated with the retirement

serializationstring

The serialization of the carbon credits associated with the retirement

vintagestring

The vintage year of the carbon credits associated with the retirement

amountnumber required

The amount of the retirement

Example response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "reason": "Reached retirement age",
  "comment": "Congratulations on your retirement!",
  "beneficiary": "John Doe",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "organizationOwner": {
    "total": 100,
    "currentPage": 1,
    "pageCount": 10,
    "nextPage": 2
  },
  "serialization": "ICR-ISL-354-78040-14-R-0-2021",
  "vintage": "2020",
  "amount": 1000,
  "project": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "fullName": "Project 1",
    "url": "https://api.carbonregistry.com/projects/47abd663-fb35-4b2e-ad08-c347e761649e",
    "publicUrl": "https://carbonregistry.com/explore/projects/47abd663-fb35-4b2e-ad08-c347e761649e"
  }
}