v2

latestOpenAPI 3.1.02026-08-054181117.0 KB

Retirement Credit Batches

List of credit batches for a given retirement.

get/retirements/{id}/credit_batches

Path parameters

idstring required

Example:ret_1FYBH4QDT1S0SVKF

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"
    }
  ]
}