Custom Field

Custom fields define company-specific fields for accounts, teams, and users.

📄️ Add Custom Field

Creates a custom field definition for accounts, teams, or users in the authenticated company. Requires the `customField:save` permission on the company (or on the relevant workflows when `workflowIds` is set). Calculation fields are validated before saving. To set a field's value on a record, update that account, team, or user instead.

📄️ Get Custom Field

Retrieves a single custom field definition by `fieldId`, including its type, label, format, options, and role-based visibility. Use `/customField/list` to discover field IDs for an entity type.

📄️ List Custom Fields

Lists custom field definitions in the authenticated company for one `tableType` (`Account`, `Team`, or `User`), sorted by display order. Account fields are limited to those available for `workflowId`, or to workflows visible to you when `workflowId` is omitted. Fields restricted to roles you do not have are excluded, as are archived fields unless `showArchived` is set. Use `/customField/get` for a single field by ID.

📄️ Remove Custom Field

Archives a custom field by default. Only recently created custom fields can be permanently deleted by setting `archive` to `false`. Requires the `customField:save` permission on the company. To restore an archived field, use `/customField/update` with `isDeleted` set to `false`.

📄️ Update Custom Field

Updates a custom field definition, such as its label, description, format, options, workflows, order, or view and edit roles. Fields that are omitted keep their current values. Requires the `customField:save` permission on the company (or on the relevant workflows when `workflowIds` is set). This changes the field definition, not the values stored on records.