Carbon

Dimension

The dimension resource.

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

List dimensions

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

Retrieve a dimension

Fetch a single dimension by filtering on `id`.

Query parameters

idstring

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

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

Create a dimension

Create a new dimension.

Body parameters

namestringrequired
entityTypedimensionEntityTyperequired
companyGroupIdstringrequired

References companyGroup.id

activebooleanrequired
requiredbooleanrequired
POSThttps://rest.carbon.ms/dimension
curl --request POST \
  --url https://rest.carbon.ms/dimension \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"name":"Example","entityType":"string","companyGroupId":"xyz789","active":true,"required":true}'
Response
{
  "id": "abc123def456",
  "name": "Example",
  "entityType": "string",
  "companyGroupId": "xyz789",
  "active": true,
  "required": true,
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z"
}
PATCH/dimension

Update a dimension

Update an existing dimension, matched on `id`.

Body parameters

namestringrequired
entityTypedimensionEntityTyperequired
companyGroupIdstringrequired

References companyGroup.id

activebooleanrequired
requiredbooleanrequired
PATCHhttps://rest.carbon.ms/dimension
curl --request PATCH \
  --url 'https://rest.carbon.ms/dimension?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",
  "entityType": "string",
  "companyGroupId": "xyz789",
  "active": true,
  "required": true,
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z"
}
DELETE/dimension

Delete a dimension

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

Query parameters

idstring

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

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