latestOpenAPI 3.0.02026-08-10517386.6 KB

a9f1b102faca

Organizations

Get organization inventory requests

This endpoint returns a paginated list of the organization's inventory requests

get/organizations/{id}/inventory/requests

Path parameters

limitnumber required

The amount of items to return

pagenumber required

The page to return

idstring required

The organization's Id

statesstring[] required

Headers

x-icr-api-versionstring

API version

Response

Example response

{
  "pagination": {
    "total": 100,
    "currentPage": 1,
    "pageCount": 10,
    "nextPage": 2
  },
  "creditRequests": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "toAddress": "0x1234567890abcdef",
      "createdAt": "2022-01-01T00:00:00Z",
      "updatedAt": "2022-01-01T00:00:00Z",
      "tokenId": "123e4567-e89b-12d3-a456-426614174000",
      "tokenAddress": "0x1234567890abcdef",
      "creditId": "exPost-2-0x1234567890abcdef",
      "serialization": "serialization",
      "vintage": "2020",
      "amount": 1000,
      "fromOrganizationId": "123e4567-e89b-12d3-a456-426614174000",
      "toOrganizationId": "123e4567-e89b-12d3-a456-426614174000",
      "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"
      },
      "txId": "0x1234567890abcdef",
      "retirementId": "1",
      "retirementReason": "reason",
      "retirementComment": "comment",
      "beneficiaryName": "John Doe"
    }
  ]
}