---
title: "Get all retirements"
method: GET
path: "/v1/retirements"
tags: ["Retirements"]
---

# Get all retirements

`GET /v1/retirements`

## Request

- Base URL: `https://api.carbonregistry.com`
- URL: `https://api.carbonregistry.com/v1/retirements`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/carbonregistry/apis/carbonregistry-api/docs/v1/retirements/get.ts> (a function with typed inputs; its response is checked against the schema)

## Query parameters

- `limit` number
- `page` number

## Response `200`

- RetirementsResponseDto
  - `retirements` ApiRetirementDto[], required
    - `createdAt` string, date-time, required: The date of when this retirement was made
    - `id` string, required: The ID of the retirement
    - `isClaimed` boolean: Whether this retirement has been claimed - is false if the retirement happened permissionlessly on blockchain and owner has not claimed the retirement on ICR
    - `reason` string: The reason for the retirement
    - `comment` string: A comment about the retirement
    - `beneficiary` string: The name of the retiree
    - `organizationId` string, required: The ID of the organization associated with the retirement
    - `organizationOwner` ApiEntityDto
      - `fullName` string, required: The full name of the entity
      - `logo` string, required: The url of the logo of the entity
      - `id` string, required: The ID of the entity
      - `publicUrl` string: The URL to the entity's public page on the CarbonRegistry.com
    - `serialization` string: The serialization of the carbon credits associated with the retirement
    - `vintage` string: The vintage year of the carbon credits associated with the retirement
    - `amount` number, required: The amount of the retirement
    - `project` ApiProject, required
      - `id` string, required: The ID of the project
      - `fullName` string, required: The full name of the project
      - `url` string, required: The URL of the project
      - `publicUrl` string, required: The public URL of the project
      - `num` number, required: Project number. This is a unique identifier for the project
  - `pagination` ApiPaginationDto, required
    - `total` number, required: Total number of items
    - `currentPage` number, required: Current page number
    - `pageCount` number, required: Total number of pages
    - `nextPage` number: Next page number
    - `prevPage` number: Previous page number

---

[API](https://skmtc.dev/carbonregistry/apis/carbonregistry-api.md) - [All operations](https://skmtc.dev/carbonregistry/apis/carbonregistry-api/llms.txt) - [OpenAPI document](https://skmtc.dev/carbonregistry/apis/carbonregistry-api/revisions/b0f71533dff5?raw)