Customer Account

The customer account resource.

Basehttps://rest.carbon.ms/customerAccount

GET/customerAccount

List customer accounts

Retrieve a paginated list of customer accounts. Filter, order, and select columns with PostgREST query parameters.

Query parameters

selectstring

Comma-separated columns to return. Defaults to all.

orderstring

Column to sort by, e.g. `createdAt.desc`.

limitinteger

Maximum rows to return.

offsetinteger

Rows to skip, for pagination.

GEThttps://rest.carbon.ms/customerAccount

curl --request GET \
  --url 'https://rest.carbon.ms/customerAccount?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'

Response

[
  {
    "id": "abc123def456",
    "companyId": "xyz789",
    "customerId": "xyz789",
    "active": true
  }
]

GET/customerAccount

Retrieve a customer account

Fetch a single customer account by filtering on `id`.

Query parameters

idstring

Match on the customer account's `id`, e.g. `eq.{id}`.

GEThttps://rest.carbon.ms/customerAccount

curl --request GET \
  --url 'https://rest.carbon.ms/customerAccount?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

Response

{
  "id": "abc123def456",
  "companyId": "xyz789",
  "customerId": "xyz789",
  "active": true
}

POST/customerAccount

Create a customer account

Create a new customer account.

Body parameters

customerIdstringrequired

References customer.id

activebooleanrequired

POSThttps://rest.carbon.ms/customerAccount

curl --request POST \
  --url https://rest.carbon.ms/customerAccount \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"customerId":"xyz789","active":true}'

Response

{
  "id": "abc123def456",
  "companyId": "xyz789",
  "customerId": "xyz789",
  "active": true
}

PATCH/customerAccount

Update a customer account

Update an existing customer account, matched on `id`.

Body parameters

customerIdstringrequired

References customer.id

activebooleanrequired

PATCHhttps://rest.carbon.ms/customerAccount

curl --request PATCH \
  --url 'https://rest.carbon.ms/customerAccount?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"customerId":"xyz789"}'

Response

{
  "id": "abc123def456",
  "companyId": "xyz789",
  "customerId": "xyz789",
  "active": true
}

DELETE/customerAccount

Delete a customer account

Delete a customer account, matched on `id`. Returns 204 No Content.

Query parameters

idstring

The `id` of the customer account to delete, e.g. `eq.{id}`.

DELETEhttps://rest.carbon.ms/customerAccount

curl --request DELETE \
  --url 'https://rest.carbon.ms/customerAccount?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

204 No Content