Skip to main content

Labels

Labels in the Registry API are attached to an issuance which indicate additional accreditation for the issued CORCs, such as ICVCM CCP or CORSIA eligibility.

Data schema​

A label object contains the following information:

  • id: The unique identifier of the label.
  • parentId: The unique identifier of the parent label (if applicable). Labels can be organized hierarchically so that parent labels might be required for their child labels to be applied.
  • name: The label's value or name.
  • createdOn: The datetime when the label was created.

Listing Labels​

To retrieve a list of labels, you can use the /registry/labels endpoint with a GET request. This endpoint supports pagination parameters:

  • limit: The maximum number of items to return (default: 100, max: 100)
  • offset: The number of items to skip (default: 0)

Example Requests​

Basic example:​

List labels
curl -X 'GET' "/registry/labels" \
  -H "Accept: application/json" \
  -H "Authorization: Basic $BASIC"

Example with pagination:​

List labels
curl -X 'GET' "/registry/labels?limit=10&offset=0" \
  -H "Accept: application/json" \
  -H "Authorization: Basic $BASIC"

Response Structure​

The response includes a pagination object with information about the total number of items, the current offset, and the limit applied. The data array contains the list of label objects.

{
  "pagination": {
    "total": 20,
    "offset": 0,
    "limit": 10
  },
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "parentId": null,
      "name": "CCP-Approved",
      "createdOn": "2025-01-01T00:00:00.000Z"
    },
    {
      "id": "3ka82f69-5717-4932-b3fc-2c963f88afa6",
      "parentId": null,
      "name": "CORSIA Eligible",
      "createdOn": "2024-01-01T00:00:00.000Z"
    }
    // Additional labels...
  ]
}

Conclusion​

This completes the Registry API getting started guide. For more detailed information, refer to the OpenAPI specification or contact Puro.earth support.