Carbon

Customer Type

The customer type resource.

Basehttps://rest.carbon.ms/customerType
GET/customerType

List customer types

Retrieve a paginated list of customer types. 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/customerType
curl --request GET \
  --url 'https://rest.carbon.ms/customerType?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'
Response
[
  {
    "id": "abc123def456",
    "name": "Example",
    "protected": true,
    "companyId": "xyz789",
    "createdAt": "2026-01-01T00:00:00Z",
    "createdBy": "string",
    "updatedBy": "string",
    "updatedAt": "2026-01-01T00:00:00Z"
  }
]
GET/customerType

Retrieve a customer type

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

Query parameters

idstring

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

GEThttps://rest.carbon.ms/customerType
curl --request GET \
  --url 'https://rest.carbon.ms/customerType?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
Response
{
  "id": "abc123def456",
  "name": "Example",
  "protected": true,
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z",
  "createdBy": "string",
  "updatedBy": "string",
  "updatedAt": "2026-01-01T00:00:00Z"
}
POST/customerType

Create a customer type

Create a new customer type.

Body parameters

namestringrequired
protectedbooleanrequired
companyIdstringrequired

References company.id

customFieldsobject
tagsarray
POSThttps://rest.carbon.ms/customerType
curl --request POST \
  --url https://rest.carbon.ms/customerType \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"name":"Example","protected":true,"companyId":"xyz789"}'
Response
{
  "id": "abc123def456",
  "name": "Example",
  "protected": true,
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z",
  "createdBy": "string",
  "updatedBy": "string",
  "updatedAt": "2026-01-01T00:00:00Z"
}
PATCH/customerType

Update a customer type

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

Body parameters

namestringrequired
protectedbooleanrequired
companyIdstringrequired

References company.id

customFieldsobject
tagsarray
PATCHhttps://rest.carbon.ms/customerType
curl --request PATCH \
  --url 'https://rest.carbon.ms/customerType?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"name":"Example"}'
Response
{
  "id": "abc123def456",
  "name": "Example",
  "protected": true,
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z",
  "createdBy": "string",
  "updatedBy": "string",
  "updatedAt": "2026-01-01T00:00:00Z"
}
DELETE/customerType

Delete a customer type

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

Query parameters

idstring

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

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