API Reference

The CustomField object

A custom field represents a field for which you can add value on various entities.

CustomField properties

integer

ID of the custom field.

string | null

ID of the custom field in a foreign system (ex: Zendesk).

string

Type of entity on which to use this custom field.

string

The name of the custom field.

string | null

The description of the custom field.

integer

Order in which custom fields are displayed.

boolean

Whether this custom field is required.

string | null

The type of the managed field.

NumberDataTypeDefinition | TextDataTypeDefinition | BooleanDataTypeDefinition

The settings for this custom field, dependent on the data type.

ISO 8601 datetime

When the custom field was created.

ISO 8601 datetime

When the custom field was last updated.

ISO 8601 datetime

When the custom field was deactivated.

CustomField example object

{
  "id": 123,
  "external_id": "custom-field-84203241",
  "object_type": "Ticket",
  "label": "Test field",
  "description": "An amazing field description.",
  "priority": 1,
  "required": true,
  "managed_type": "contact_reason",
  "definition": {
    "input_settings": {
      "placeholder": "Enter this here...",
      "min": "120.5",
      "max": "130",
      "input_type": "input_number"
    },
    "data_type": "number"
  },
  "created_datetime": "2019-01-02T03:04:05.123456",
  "updated_datetime": "2020-01-02T03:04:05.123456",
  "deactivated_datetime": "2021-01-02T03:04:05.123456"
}