Retirements

Endpoints that return retirement certificates carbonregistry.com has issued

Get all retirements

GEThttps://api.carbonregistry.com/v1/retirements

Authorization

Query parameters

Response

Body

retirements*array of ApiRetirementDto (object)

pagination*ApiPaginationDto (object)

Request

Response

Get a specific retirement by ID

GEThttps://api.carbonregistry.com/v1/retirements/{id}

Authorization

Path parameters

id*string

The ID of the retirement

Response

Body

retirement*ApiRetirementDto (object)

Request

Response

Get retirements for an entity

GEThttps://api.carbonregistry.com/v1/{id}/retirements

Authorization

Path parameters

id*string

Entity ID

Response

Body

retirements*array of ApiRetirementCertificateDto (object)

Request

Response

PreviousTransactions NextCredit actions

Last updated 14 hours ago

const response = await fetch('https://api.carbonregistry.com/v1/retirements', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

{
  "retirements": [
    {
      "createdAt": "2024-11-07T02:50:39.907Z",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "isClaimed": false,
      "reason": "Reached retirement age",
      "comment": "Congratulations on your retirement!",
      "beneficiary": "John Doe",
      "organizationId": "123e4567-e89b-12d3-a456-426614174000",
      "organizationOwner": {
        "fullName": "John Doe",
        "logo": "https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcRzKakVt-GHFNrAN9xFd8B26vYVFLyWoUds8w&usqp=CAU",
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "publicUrl": "https://www.carbonregistry.com/explore/organizations/62ffdcad-bd0d-42f7-b8ff-28785a929ed0"
      },
      "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",
        "num": "713"
      }
    }
  ],
  "pagination": {
    "total": 100,
    "currentPage": 1,
    "pageCount": 10,
    "nextPage": 2,
    "prevPage": 0
  }
}

const response = await fetch('https://api.carbonregistry.com/v1/retirements/{id}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

{
  "retirement": {
    "createdAt": "2024-11-07T02:50:39.907Z",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "isClaimed": false,
    "reason": "Reached retirement age",
    "comment": "Congratulations on your retirement!",
    "beneficiary": "John Doe",
    "organizationId": "123e4567-e89b-12d3-a456-426614174000",
    "organizationOwner": {
      "fullName": "John Doe",
      "logo": "https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcRzKakVt-GHFNrAN9xFd8B26vYVFLyWoUds8w&usqp=CAU",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "publicUrl": "https://www.carbonregistry.com/explore/organizations/62ffdcad-bd0d-42f7-b8ff-28785a929ed0"
    },
    "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",
      "num": "713"
    }
  }
}

const response = await fetch('https://api.carbonregistry.com/v1/{id}/retirements', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

{
  "retirements": [
    {
      "createdAt": "2024-11-07T02:50:39.907Z",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "isClaimed": false,
      "reason": "Reached retirement age",
      "comment": "Congratulations on your retirement!",
      "beneficiary": "John Doe",
      "organizationId": "123e4567-e89b-12d3-a456-426614174000",
      "organizationOwner": {
        "fullName": "John Doe",
        "logo": "https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcRzKakVt-GHFNrAN9xFd8B26vYVFLyWoUds8w&usqp=CAU",
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "publicUrl": "https://www.carbonregistry.com/explore/organizations/62ffdcad-bd0d-42f7-b8ff-28785a929ed0"
      },
      "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",
        "num": "713"
      }
    }
  ]
}