List Custom Fields
gorgias_list_custom_fieldsRetrieve a paginated list of custom fields for tickets or customers. Filter by name, archived status, and sort order.
Instructions
GET /api/custom-fields — Returns a cursor-paginated list of custom fields. Requires object_type to specify which entity's fields to list. Supports filtering by name search and archived status.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"object_type": "<object_type>"
},
"name": "gorgias_list_custom_fields"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Maximum number of custom fields to return per page (1-100, default 30) | |
| cursor | No | Cursor token for pagination. Use next_cursor or prev_cursor from a previous response. | |
| search | No | Filter custom fields by name (substring match). | |
| archived | No | If true, return only archived custom fields. If false or omitted, return active fields. | |
| order_by | No | Sort order. Default: 'priority:desc'. | |
| object_type | Yes | Type of entity to list custom fields for: 'Ticket' or 'Customer' |