Custom Field

The custom field resource.

Basehttps://rest.carbon.ms/customField

GET/customField

List custom fields

Retrieve a paginated list of custom fields. 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/customField

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

Response

[
  {
    "id": "abc123def456",
    "name": "Example",
    "sortOrder": 0,
    "table": "string",
    "dataTypeId": 0,
    "companyId": "xyz789",
    "createdAt": "2026-01-01T00:00:00Z",
    "createdBy": "string"
  }
]

GET/customField

Retrieve a custom field

Fetch a single custom field by filtering on `id`.

Query parameters

idstring

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

GEThttps://rest.carbon.ms/customField

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

Response

{
  "id": "abc123def456",
  "name": "Example",
  "sortOrder": 0,
  "table": "string",
  "dataTypeId": 0,
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z",
  "createdBy": "string"
}

POST/customField

Create a custom field

Create a new custom field.

Body parameters

namestringrequired

sortOrdernumberrequired

tablestringrequired

References customFieldTable.table

dataTypeIdnumberrequired

References attributeDataType.id

listOptionsarray

activeboolean

companyIdstringrequired

References company.id

tagsarray

requiredbooleanrequired

POSThttps://rest.carbon.ms/customField

curl --request POST \
  --url https://rest.carbon.ms/customField \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"name":"Example","sortOrder":0,"table":"string","dataTypeId":0,"companyId":"xyz789","required":true}'

Response

{
  "id": "abc123def456",
  "name": "Example",
  "sortOrder": 0,
  "table": "string",
  "dataTypeId": 0,
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z",
  "createdBy": "string"
}

PATCH/customField

Update a custom field

Update an existing custom field, matched on `id`.

Body parameters

namestringrequired

sortOrdernumberrequired

tablestringrequired

References customFieldTable.table

dataTypeIdnumberrequired

References attributeDataType.id

listOptionsarray

activeboolean

companyIdstringrequired

References company.id

tagsarray

requiredbooleanrequired

PATCHhttps://rest.carbon.ms/customField

curl --request PATCH \
  --url 'https://rest.carbon.ms/customField?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",
  "sortOrder": 0,
  "table": "string",
  "dataTypeId": 0,
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z",
  "createdBy": "string"
}

DELETE/customField

Delete a custom field

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

Query parameters

idstring

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

DELETEhttps://rest.carbon.ms/customField

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

204 No Content