GET
/
credit_batches
/
{id}

Authorizations

Authorization
string
headerrequired

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

id
string
required

Response

200 - application/json
beneficiary
object | null
required
carbon_removal_data
object | null
required

Carbon removal data for this credit batch

country_of_issue
string
required
id
string
required
issuance_id
string
required
issued_at
string
required
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.

owner
object
required
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.

project_id
string
required
removal_id
string
required
removal_location
object | null
required

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

retired_at
string | null
required
retirement_id
string | null
required
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.

sequestered_on
string
required
serial_number
string
required
size
object
required
status
enum<string>
required
Available options:
active,
split,
retired
supplier_id
string
required

Was this page helpful?