v1

latestOpenAPI 3.1.02026-07-24111290748.0 KB

Custom Fields

List custom fields

List custom fields matching the given parameters, paginated, and ordered.

get/api/custom-fields

Query parameters

object_type'Ticket' | 'Customer' required

Example:Ticket

Type of entity on which to use this custom field.

searchstring

Example:My awesome field

Search for custom fields' names matching the given text query (case insensitive).

archivedboolean

Example:true

A filter parameter used to return archived or non-archived only results.

order_by'priority:asc' | 'priority:desc'

Example:priority:desc

Attribute used to priority the errors.

cursorstring

Example:cHJldl9fNl9fMjAyMS0wMy0wMyAwNjowMDowMA==

Value indicating your position in the list of all items. If omitted, the first items of the list will be returned.

limitinteger

Maximum number of items to return.

Response

List of custom fields according to the given criteria.

objectstring required

uristring required

Example response

{
  "data": [
    {
      "id": 123,
      "external_id": "custom-field-84203241",
      "label": "Test field",
      "description": "An amazing field description.",
      "priority": 1,
      "required": true,
      "definition": {
        "input_settings": {
          "placeholder": "Enter this here..."
        }
      },
      "created_datetime": "2019-01-02T03:04:05.123456",
      "updated_datetime": "2020-01-02T03:04:05.123456",
      "deactivated_datetime": "2021-01-02T03:04:05.123456"
    }
  ]
}