latestOpenAPI 3.0.02026-08-10235750.6 KB
b0f71533dff5
Retirements
Get all retirements
get/v1/retirements
Query parameters
limitnumber
Limit the number of results returned
pagenumber
Page number for pagination
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": {
"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"
}
}
],
"pagination": {
"total": 100,
"currentPage": 1,
"pageCount": 10,
"nextPage": 2
}
}