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": "<string>",
"total": {
"active_credits_total": {
"credit_kgs": 123,
"credits": 123
},
"retired_credits_total": {
"credit_kgs": 123,
"credits": 123
}
}
}
],
"supplier_balances": [
{
"supplier_id": "<string>",
"total": {
"active_credits_total": {
"credit_kgs": 123,
"credits": 123
},
"retired_credits_total": {
"credit_kgs": 123,
"credits": 123
}
}
}
],
"total": {
"active_credits_total": {
"credit_kgs": 123,
"credits": 123
},
"retired_credits_total": {
"credit_kgs": 123,
"credits": 123
}
}
}Organisation Credit Balance
Information about active and retired credits owned by the given organisation.
Includes total balances as well as balances split by projects and suppliers.
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": "<string>",
"total": {
"active_credits_total": {
"credit_kgs": 123,
"credits": 123
},
"retired_credits_total": {
"credit_kgs": 123,
"credits": 123
}
}
}
],
"supplier_balances": [
{
"supplier_id": "<string>",
"total": {
"active_credits_total": {
"credit_kgs": 123,
"credits": 123
},
"retired_credits_total": {
"credit_kgs": 123,
"credits": 123
}
}
}
],
"total": {
"active_credits_total": {
"credit_kgs": 123,
"credits": 123
},
"retired_credits_total": {
"credit_kgs": 123,
"credits": 123
}
}
}Authorizations
A 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
Successful Response
Show child attributes
Show child attributes
20 - 37Show child attributes
Show child attributes
Show child attributes
Show child attributes
A representation of the credit quantity as an integer kilogram amount. Where 1 unit represents 0.001 credits and 1 kilogram of CO₂e. This field can handle bigint values.
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.
Show child attributes
Show child attributes
A representation of the credit quantity as an integer kilogram amount. Where 1 unit represents 0.001 credits and 1 kilogram of CO₂e. This field can handle bigint values.
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.
Show child attributes
Show child attributes
20 - 37Show child attributes
Show child attributes
Show child attributes
Show child attributes
A representation of the credit quantity as an integer kilogram amount. Where 1 unit represents 0.001 credits and 1 kilogram of CO₂e. This field can handle bigint values.
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.
Show child attributes
Show child attributes
A representation of the credit quantity as an integer kilogram amount. Where 1 unit represents 0.001 credits and 1 kilogram of CO₂e. This field can handle bigint values.
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.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
A representation of the credit quantity as an integer kilogram amount. Where 1 unit represents 0.001 credits and 1 kilogram of CO₂e. This field can handle bigint values.
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.
Show child attributes
Show child attributes
A representation of the credit quantity as an integer kilogram amount. Where 1 unit represents 0.001 credits and 1 kilogram of CO₂e. This field can handle bigint values.
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?