Organizations

Get organization retirements

This endpoint returns a paginated list of the organization's retirements

get/organizations/{id}/retirements

Request

Base URL
https://api.carbonregistry.com
Auth
none declared
TypeScript
https://skmtc.dev/carbonregistry/apis/carbon-registry-rest-api/docs/organizations/:id/retirements/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

limitnumber required

The amount of items to return

pagenumber required

The page to return

idstring required

The organization's Id

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"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.