Sign in
Retirements

List retirements

This endpoint returns all retirements, both on platform and off - if a retirement has not been claimed by a KYBd organization the only data shown is the amount and the project and a pdf can not be generated.

get/retirements/list

Query parameters

skipnumber required

The amount of items to skip

firstnumber required

The number of elements to return

Headers

x-icr-api-versionstring

API version

Response

Example response

{
  "retirements": [
    {
      "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"
      }
    }
  ]
}