v2

latestOpenAPI 3.1.02026-08-054181117.0 KB

Organisation Credit Batches

A paginated list of all credit batches currently owned or retired on behalf of the organisation, sorted by issuance date. By default it excludes batches with the status 'split'.

Note that when combining filters, the result will be the intersection of them. For example, when filtering by supplier_id and issued_after, the result will only include credit batches from the specified supplier that have been issued after the specified date.

get/organisations/{id}/credit_batches

Path parameters

idstring required

Example:org_1GB56M1ST1S0GVNA

The ID of the organisation.

Query parameters

supplier_idstring

Example:spl_1CC712KFS1S0YKPS

Filter credit batches by the supplier that was issued the credits

project_idstring

Example:prj_1CTWZQGKE1S0VAXA

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

issuance_idstring

Example:iss_1EWT8R5FY1S0GFCY

Filter credit batches by their issuance

delivery_idstring

Example:dlv_1C454ZXA61S03Z9T

Filter credit batches by the delivery that they were part of

order_idstring

Example:ord_1FAN3S3WV1S0B842

Filter credit batches by the order they have been delivered against

retirement_idstring

Example:ret_1FYBH4QDT1S0SVKF

Filter credit batches by the retirement they have been part of

statusCreditBatchStatus[] nullable

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

issued_afterstring date-time nullable

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

Example:2021-01-01T00:00:00Z

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

issued_beforestring date-time nullable

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

Example:2024-01-01T00:00:00Z

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

lastinteger

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.

beforestring nullable

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.

firstinteger

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.

afterstring nullable

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.

sort_field'issued_at'

sort_direction'asc' | 'desc'

Headers

x-client-secretstring required

A secret token identifying the client connecting to the API

Example:Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP

A secret token identifying the client connecting to the API

Response

Successful Response

total_countinteger required

Example response

{
  "nodes": [
    {
      "id": "ctb_1DRBTYA8Q1S07CBY",
      "serial_number": "ISO-1-BSTORE-GBR-F5X7-2024-78177-81177",
      "size": {
        "credits": 125.632,
        "credit_kgs": 125632
      },
      "country_of_issue": "GBR",
      "supplier_id": "spl_1CC712KFS1S0YKPS",
      "parent_id": "ctb_1DRBTYA8Q1S07CBY",
      "left_child_id": "ctb_1DRBTYA8Q1S07CBY",
      "right_child_id": "ctb_1DRBTYA8Q1S07CBY",
      "issuance_id": "iss_1EWT8R5FY1S0GFCY",
      "delivery_id": "dlv_1C454ZXA61S03Z9T",
      "beneficiary": {
        "id": "org_1GB56M1ST1S0GVNA",
        "name": "Isometric",
        "domain": "isometric.com"
      },
      "retirement_id": "ret_1FYBH4QDT1S0SVKF",
      "ghg_entry_id": "rmv_1EEM6NJXX1S0EXKD",
      "removal_id": "rmv_1EEM6NJXX1S0EXKD",
      "owner": {
        "id": "org_1GB56M1ST1S0GVNA",
        "name": "Isometric",
        "domain": "isometric.com"
      },
      "project_id": "prj_1CTWZQGKE1S0VAXA"
    }
  ]
}