Skip to content

Custom fields API

8 endpoints. All requests need an Authorization header — see Authentication. API keys additionally need the matching scope.

Method Path Description
GET /api/custom-fields List Fields Query: object_type, is_active.
POST /api/custom-fields Create Field Accepts a JSON body.
POST /api/custom-fields/reorder Reorder Fields Accepts a JSON body. Query: object_type.
GET /api/custom-fields/standard/{object_type} List Standard Fields
GET /api/custom-fields/values/{object_type}/{record_id} Get Field Values
PUT /api/custom-fields/values/{object_type}/{record_id} Set Field Values Accepts a JSON body.
PATCH /api/custom-fields/{field_id} Update Field Accepts a JSON body.
DELETE /api/custom-fields/{field_id} Delete Field

Try it

The full request/response schema for every endpoint is in the OpenAPI spec served by your own workspace.