Subaccounts

Endpoints for managing entity's subaccounts

Get accounts for an entity

get

Returns a list of all the subaccounts this entity owns.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Entity ID

Responses

200Success

application/json

get

/v1/{id}/accounts

HTTPcURLJavaScriptPython

GET /v1/{id}/accounts HTTP/1.1
Host: api.carbonregistry.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "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

post

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Entity ID

Body

application/json

namestringRequired

The name associated with this subaccount

Example: Customer 1 account

Responses

200Success

application/json

post

/v1/{id}/accounts

HTTPcURLJavaScriptPython

POST /v1/{id}/accounts HTTP/1.1
Host: api.carbonregistry.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 29

{
  "name": "Customer 1 account"
}

200Success

{
  "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

delete

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Entity ID

accIdstringRequired

Subaccount ID to delete

Responses

200Success

application/json

delete

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

HTTPcURLJavaScriptPython

DELETE /v1/{id}/accounts/{accId} HTTP/1.1
Host: api.carbonregistry.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

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