Documentation

GET

organisations

{id}

credit_batches

curl --request GET \
  --url https://api.sandbox.isometric.com/registry/v0/organisations/{id}/credit_batches \
  --header 'Authorization: Bearer <token>' \
  --header 'x-client-secret: <x-client-secret>'

{
  "nodes": [
    {
      "beneficiary": {
        "domain": "isometric.com",
        "id": "abc_1H0G39139CF0DZB2",
        "name": "Isometric"
      },
      "carbon_removal_data": {
        "counterfactuals_kg": 123,
        "emissions_kg": 123,
        "gross_carbon_removed_kg": 123,
        "losses_kg": 123,
        "net_carbon_removed_kg": 123
      },
      "ccp_approved": true,
      "country_of_issue": "GBR",
      "id": "abc_1H0G39139CF0DZB2",
      "issuance_id": "pfx_1H0G39139CF0DZB2",
      "issued_at": "2023-11-07T05:31:56Z",
      "left_child_id": "pfx_1H0G39139CF0DZB2",
      "owner": {
        "domain": "isometric.com",
        "id": "abc_1H0G39139CF0DZB2",
        "name": "Isometric"
      },
      "parent_id": "pfx_1H0G39139CF0DZB2",
      "project_id": "pfx_1H0G39139CF0DZB2",
      "removal_id": "pfx_1H0G39139CF0DZB2",
      "removal_location": {
        "country_code": "<string>",
        "country_name": "<string>"
      },
      "retired_at": "2023-11-07T05:31:56Z",
      "retirement_id": "pfx_1H0G39139CF0DZB2",
      "right_child_id": "pfx_1H0G39139CF0DZB2",
      "sequestered_on": "2023-12-25",
      "serial_number": "ISO-1-BSTORE-GBR-F5X7-2024-78177-81177",
      "size": {
        "credit_kgs": 125632,
        "credits": 125.632
      },
      "status": "active",
      "supplier_id": "pfx_1H0G39139CF0DZB2"
    }
  ],
  "page_info": {
    "end_cursor": "<string>",
    "has_next_page": true,
    "has_previous_page": true,
    "start_cursor": "<string>"
  },
  "total_count": 123
}

Authorizations

Authorization

string

header

required

A JWT Bearer token header for authentication and authorization, in the format Authorization: Bearer <token>

Headers

x-client-secret

string

required

A secret token identifying the client connecting to the API

Path Parameters

string

required

The ID of the organisation.

Query Parameters

supplier_id

string | null

Filter credit batches by the supplier that was issued the credits

project_id

string | null

Filter credit batches by the project that the credits were issued for

issuance_id

string | null

Filter credit batches by their issuance

delivery_id

string | null

Filter credit batches by the delivery that they were part of

order_id

string | null

Filter credit batches by the order they have been delivered against

retirement_id

string | null

Filter credit batches by the retirement they have been part of

status

enum<string>[] | null

Filter credit batches by status. Note that 'split' status is excluded by default.

Available options:

active,

split,

retired

issued_after

string | null

Filter credit batches to only return ones issued strictly after this timestamp. Format: ISO8601-like including timezone, eg. 2021-01-01T00:00:00Z

issued_before

string | null

Filter credit batches to only return ones issued strictly before this timestamp. Format: ISO8601-like including timezone, eg. 2024-01-01T00:00:00Z

last

integer

default:

An integer number of items to retrieve before the item represented by the cursor passed in the before parameter. Defaults to 10 with a maximum value of 50.

Required range: 0 < x < 50

before

string | null

An opaque cursor representing the first item in the previously requested page to select items ordered before it. Submit the previously requested page’s start_cursor here when paginated backwards.

Minimum length: 1

first

integer

default:

An integer number of items to retrieve after the item represented by the cursor passed in the after parameter. Defaults to 10 with a maximum value of 50.

Required range: 0 < x < 50

after

string | null

An opaque cursor representing the last item in the previously requested page to select items ordered after it. Submit the previously requested page’s end_cursor here when paginated forwards.

Minimum length: 1

sort_field

enum<string>

Available options:

issued_at

sort_direction

enum<string>

Available options:

asc,

desc

Response

200

application/json

Successful Response

nodes

object[]

required

nodes.beneficiary

object | null

required

nodes.carbon_removal_data

object | null

required

Carbon removal data for this credit batch

nodes.ccp_approved

boolean

required

Whether this credit batch has been issued as part of a ICVCM Core Carbon Principles (CCP) approved project

nodes.country_of_issue

string

required

Required string length: 3

nodes.id

string

required

Required string length: 20 - 36

nodes.issuance_id

string

required

Required string length: 20 - 36

nodes.issued_at

string

required

nodes.left_child_id

string | null

required

If this credit batch has status SPLIT, it will have two child batches representing the two halves of this split.

Required string length: 20 - 36

nodes.owner

object

required

nodes.parent_id

string | null

required

If this credit batch was created from splitting a larger batch in two, this will be set to the id of the parent credit batch.

Required string length: 20 - 36

nodes.project_id

string

required

Required string length: 20 - 36

nodes.removal_id

string

required

Required string length: 20 - 36

nodes.removal_location

object | null

required

The location of the facility where this carbon removal took place, if available

nodes.retired_at

string | null

required

nodes.retirement_id

string | null

required

Required string length: 20 - 36

nodes.right_child_id

string | null

required

If this credit batch has status SPLIT, it will have two child batches representing the two halves of this split.

Required string length: 20 - 36

nodes.sequestered_on

string

required

nodes.serial_number

string

required

nodes.size

object

required

nodes.status

enum<string>

required

Available options:

active,

split,

retired

nodes.supplier_id

string

required

Required string length: 20 - 36

page_info

object

required

total_count

integer

required

Was this page helpful?

Organisation Credit Balance Order

curl --request GET \
  --url https://api.sandbox.isometric.com/registry/v0/organisations/{id}/credit_batches \
  --header 'Authorization: Bearer <token>' \
  --header 'x-client-secret: <x-client-secret>'

{
  "nodes": [
    {
      "beneficiary": {
        "domain": "isometric.com",
        "id": "abc_1H0G39139CF0DZB2",
        "name": "Isometric"
      },
      "carbon_removal_data": {
        "counterfactuals_kg": 123,
        "emissions_kg": 123,
        "gross_carbon_removed_kg": 123,
        "losses_kg": 123,
        "net_carbon_removed_kg": 123
      },
      "ccp_approved": true,
      "country_of_issue": "GBR",
      "id": "abc_1H0G39139CF0DZB2",
      "issuance_id": "pfx_1H0G39139CF0DZB2",
      "issued_at": "2023-11-07T05:31:56Z",
      "left_child_id": "pfx_1H0G39139CF0DZB2",
      "owner": {
        "domain": "isometric.com",
        "id": "abc_1H0G39139CF0DZB2",
        "name": "Isometric"
      },
      "parent_id": "pfx_1H0G39139CF0DZB2",
      "project_id": "pfx_1H0G39139CF0DZB2",
      "removal_id": "pfx_1H0G39139CF0DZB2",
      "removal_location": {
        "country_code": "<string>",
        "country_name": "<string>"
      },
      "retired_at": "2023-11-07T05:31:56Z",
      "retirement_id": "pfx_1H0G39139CF0DZB2",
      "right_child_id": "pfx_1H0G39139CF0DZB2",
      "sequestered_on": "2023-12-25",
      "serial_number": "ISO-1-BSTORE-GBR-F5X7-2024-78177-81177",
      "size": {
        "credit_kgs": 125632,
        "credits": 125.632
      },
      "status": "active",
      "supplier_id": "pfx_1H0G39139CF0DZB2"
    }
  ],
  "page_info": {
    "end_cursor": "<string>",
    "has_next_page": true,
    "has_previous_page": true,
    "start_cursor": "<string>"
  },
  "total_count": 123
}

Getting Started

Public Registry Data

Buyer Account Management

Supplier Account Management

Organisation Credit Batches

Authorizations

Headers

Path Parameters

Query Parameters

Response