Credit Batch
Information about a specific credit batch.
GET
/
credit_batches
/
{id}
Authorizations
Authorization
string
headerrequiredA JWT Bearer token header for authentication and authorization, in the format Authorization: Bearer <token>
Headers
x-client-secret
string
requiredA secret token identifying the client connecting to the API
Path Parameters
id
string
requiredResponse
200 - application/json
beneficiary
object | null
requiredcarbon_removal_data
object | null
requiredCarbon removal data for this credit batch
country_of_issue
string
requiredid
string
requiredissuance_id
string
requiredissued_at
string
requiredleft_child_id
string | null
requiredIf this credit batch has status SPLIT
, it will have two child batches representing the two halves of this split.
owner
object
requiredparent_id
string | null
requiredIf this credit batch was created from splitting a larger batch in two, this will be set to the id of the parent credit batch.
project_id
string
requiredremoval_id
string
requiredremoval_location
object | null
requiredThe location of the facility where this carbon removal took place, if available
retired_at
string | null
requiredretirement_id
string | null
requiredright_child_id
string | null
requiredIf this credit batch has status SPLIT
, it will have two child batches representing the two halves of this split.
sequestered_on
string
requiredserial_number
string
requiredsize
object
requiredstatus
enum<string>
requiredAvailable options:
active
, split
, retired
supplier_id
string
requiredWas this page helpful?