younifyd
Menu

List Custom Fields

List custom fields

GET/api/custom-fields

Use it in a workflow

  1. Add a step and choose the Gorgias connector.
  2. Pick the List Custom Fields action (under Custom Fields).
  3. Fill in the fields below, then reference the result from later steps as {{listCustomFields.response.data}}.

Request

Query parameters

object_typestringrequired

Type of entity on which to use this custom field.

One ofTicketCustomer

searchstring

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

archivedboolean

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

order_bystring

Attribute used to priority the errors.

One ofpriority:ascpriority:descDefault "priority:desc"

cursorstring

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.

Default 30

Response

Returns 200 with an object. Read it in later steps with {{listCustomFields.response.data.<field>}}.

objectstring
uristring
dataarray<object>
idintegerrequired

ID of the custom field.

external_idstring

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

object_typestringrequired

One ofTicketCustomer

labelstringrequired

The name of the custom field.

descriptionstring

The description of the custom field.

priorityintegerrequired

Order in which custom fields are displayed.

requiredbooleanrequired

Whether this custom field is required.

managed_typeoneOf

The type of the managed field.

definitiononeOfrequired

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

created_datetimestring (date-time)required

When the custom field was created.

updated_datetimestring (date-time)required

When the custom field was last updated.

deactivated_datetimestring (date-time)

When the custom field was deactivated.

metaobject
prev_cursorstringrequired
next_cursorstringrequired
total_resourcesintegerrequired
json
{
  "object": "string",
  "uri": "string",
  "data": [
    {
      "id": 0,
      "object_type": "Ticket",
      "label": "string",
      "priority": 0,
      "required": false,
      "definition": null,
      "created_datetime": "2025-01-01T00:00:00Z",
      "updated_datetime": "2025-01-01T00:00:00Z",
      "external_id": "string",
      "description": "string",
      "managed_type": null,
      "deactivated_datetime": "2025-01-01T00:00:00Z"
    }
  ],
  "meta": {
    "prev_cursor": "string",
    "next_cursor": "string",
    "total_resources": 0
  }
}

Need more? See the Gorgias guide for connection setup and behaviour shared by every action.