Subaccounts

Endpoints for managing entity's subaccounts

Get accounts for an entity

Returns a list of all the subaccounts this entity owns.

GEThttps://api.carbonregistry.com/v1/{id}/accounts

Authorization

bearer

Path parameters

id*string

Entity ID

Response

200

Body

application/json

accounts*array of SubAccountDto (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.carbonregistry.com/v1/{id}/accounts', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

200

{
  "accounts": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "type": "default",
      "name": "Default",
      "address": "0x32Be343B94f860124dC4fEe278FDCBD38C102D88",
      "ownerId": "550e8400-e29b-41d4-a716-446655440000"
    }
  ]
}

Create a new subaccount for an entity

POSThttps://api.carbonregistry.com/v1/{id}/accounts

Authorization

bearer

Path parameters

id*string

Entity ID

Body

application/json

name*string

The name associated with this subaccount

Example: "Customer 1 account"

Response

200

Body

application/json

account*SubAccountDto (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.carbonregistry.com/v1/{id}/accounts', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "Customer 1 account"
    }),
});
const data = await response.json();

Response

200

{
  "account": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "type": "default",
    "name": "Default",
    "address": "0x32Be343B94f860124dC4fEe278FDCBD38C102D88",
    "ownerId": "550e8400-e29b-41d4-a716-446655440000"
  }
}

Delete an account for an entity

DELETEhttps://api.carbonregistry.com/v1/{id}/accounts/{accId}

Authorization

bearer

Path parameters

id*string

Entity ID

accId*string

Subaccount ID to delete

Response

200

Body

application/json

account*SubAccountDto (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.carbonregistry.com/v1/{id}/accounts/{accId}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

200

{
  "account": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "type": "default",
    "name": "Default",
    "address": "0x32Be343B94f860124dC4fEe278FDCBD38C102D88",
    "ownerId": "550e8400-e29b-41d4-a716-446655440000"
  }
}