- Documentation
- Homepage
- Registry
- GETBeneficiaries
- GETCredit Batch
- POSTCreate Delivery
- GETDelivery
- GETDelivery Credit Batches
- GETIssuance
- GETIssuance Credit Batches
- GETOrder
- GETOrder Deliveries
- GETCurrent Organisation
- GETOrganisation
- GETOrganisation Credit Balance
- GETOrganisation Credit Batches
- GETProject
- POSTCreate Retirement
- GETRetirement
- GETRetirement Credit Batches
- GETCurrent Supplier
- GETSupplier
- GETSupplier Deliveries
- GETSupplier Issuances
- GETSupplier Orders
- GETSupplier Projects
- GETTransferees
- POSTCreate Transfer
- GETTransfer
- GETTransfer Credit Batches
Registry API
Organisation Credit Balance
An JWT Bearer token header for authentication and authorization, in the format Authorization: Bearer <token>
A secret token identifying the client connecting to the API
curl --request GET \
--url https://api.sandbox.isometric.com/registry/v0/organisations/{id}/credit_balance \
--header 'Authorization: Bearer <token>' \
--header 'x-client-secret: <x-client-secret>'
{
"project_balances": [
{
"project_id": "pfx_1H0G39139CF0DZB2",
"total": {
"active_credits_total": {
"credit_kgs": 125632,
"credits": 125.632
},
"retired_credits_total": {
"credit_kgs": 125632,
"credits": 125.632
}
}
}
],
"supplier_balances": [
{
"supplier_id": "pfx_1H0G39139CF0DZB2",
"total": {
"active_credits_total": {
"credit_kgs": 125632,
"credits": 125.632
},
"retired_credits_total": {
"credit_kgs": 125632,
"credits": 125.632
}
}
}
],
"total": {
"active_credits_total": {
"credit_kgs": 125632,
"credits": 125.632
},
"retired_credits_total": {
"credit_kgs": 125632,
"credits": 125.632
}
}
}
Authorizations
An JWT Bearer token header for authentication and authorization, in the format Authorization: Bearer <token>
Headers
A secret token identifying the client connecting to the API
Path Parameters
Response
A representation of the credit quantity as an integer kilogram amount. Where 1 unit represents 0.001 credits and 1 kilogram of CO₂e.
A representation of the credit quantity as a fractional amount, to 3 decimal places. Where 1 unit represents 1 credit and 1 ton of CO₂e.
A representation of the credit quantity as an integer kilogram amount. Where 1 unit represents 0.001 credits and 1 kilogram of CO₂e.
A representation of the credit quantity as a fractional amount, to 3 decimal places. Where 1 unit represents 1 credit and 1 ton of CO₂e.
A representation of the credit quantity as an integer kilogram amount. Where 1 unit represents 0.001 credits and 1 kilogram of CO₂e.
A representation of the credit quantity as a fractional amount, to 3 decimal places. Where 1 unit represents 1 credit and 1 ton of CO₂e.
A representation of the credit quantity as an integer kilogram amount. Where 1 unit represents 0.001 credits and 1 kilogram of CO₂e.
A representation of the credit quantity as a fractional amount, to 3 decimal places. Where 1 unit represents 1 credit and 1 ton of CO₂e.
A representation of the credit quantity as an integer kilogram amount. Where 1 unit represents 0.001 credits and 1 kilogram of CO₂e.
A representation of the credit quantity as a fractional amount, to 3 decimal places. Where 1 unit represents 1 credit and 1 ton of CO₂e.
A representation of the credit quantity as an integer kilogram amount. Where 1 unit represents 0.001 credits and 1 kilogram of CO₂e.
A representation of the credit quantity as a fractional amount, to 3 decimal places. Where 1 unit represents 1 credit and 1 ton of CO₂e.
Was this page helpful?
curl --request GET \
--url https://api.sandbox.isometric.com/registry/v0/organisations/{id}/credit_balance \
--header 'Authorization: Bearer <token>' \
--header 'x-client-secret: <x-client-secret>'
{
"project_balances": [
{
"project_id": "pfx_1H0G39139CF0DZB2",
"total": {
"active_credits_total": {
"credit_kgs": 125632,
"credits": 125.632
},
"retired_credits_total": {
"credit_kgs": 125632,
"credits": 125.632
}
}
}
],
"supplier_balances": [
{
"supplier_id": "pfx_1H0G39139CF0DZB2",
"total": {
"active_credits_total": {
"credit_kgs": 125632,
"credits": 125.632
},
"retired_credits_total": {
"credit_kgs": 125632,
"credits": 125.632
}
}
}
],
"total": {
"active_credits_total": {
"credit_kgs": 125632,
"credits": 125.632
},
"retired_credits_total": {
"credit_kgs": 125632,
"credits": 125.632
}
}
}