Subaccounts

Endpoints for managing entity's subaccounts

Get accounts for an entity

Returns a list of all the subaccounts this entity owns.

get

/v1/{id}/accounts

Authorizations

Path parameters

idstringrequired

Entity ID

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.carbonregistry.com/v1/{id}/accounts' \
  --header 'Authorization: Bearer <token>'

200

200

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

Create a new subaccount for an entity

post

/v1/{id}/accounts

Authorizations

Path parameters

idstringrequired

Entity ID

Body

namestringrequired

The name associated with this subaccount

Example: Customer 1 account

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.carbonregistry.com/v1/{id}/accounts' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{"name":"Customer 1 account"}'

200

200

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

Delete an account for an entity

delete

/v1/{id}/accounts/{accId}

Authorizations

Path parameters

idstringrequired

Entity ID

accIdstringrequired

Subaccount ID to delete

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://api.carbonregistry.com/v1/{id}/accounts/{accId}' \
  --header 'Authorization: Bearer <token>'

200

200

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