POST

TicketCustomFields.List

List ticket custom field definitions stored in user_detail.ticket_extra_fields (same JSON as the dashboard Ticket Custom Filed step). Each field has a storage key name like a-1731562297. Groups have type=group, name like ga-..., and nested group_data.

Permissions

User must be logged in with a valid bearer token.
Returned or changed records are limited by the user permissions, team access, folder access, and account settings.

Action

Returns TicketCustomFields rows as JSON.
Supports the documented filters and paging fields.
List responses are capped at 25 rows per call.

Push Service

No push is sent because this function only reads data or returns helper information.

Automation

No automation is run for this function.

Special Instructions

This lists field DEFINITIONS (settings), not values on a ticket. Ticket values are sent on Ticket.Add / Ticket.Edit as a-{id}=value.
Owner or member-admin can change definitions; list is available to authenticated staff.

Required Parameters

No body parameters are required for this function.

Optional Parameters

Name	Type	Sample	What it gives
`search` post	string	`order`	Filter by name, English/Hebrew label, or type.
`start` post	int	`0`	Offset. Alias: offset.
`limit` post	int	`25`	Page size. Aliases: length, per_page.

Authentication

Send the bearer token returned by Login in the request header.

Authorization: Bearer YOUR TOKEN

Sample Request

{
    "url": "\/app\/TicketCustomFields.List",
    "method": "POST",
    "headers": {
        "Authorization": "Bearer YOUR TOKEN"
    },
    "body": {
        "limit": "25"
    },
    "url_user": "https:\/\/{user}.bull36.com\/app\/TicketCustomFields.List",
    "url_domain": "https:\/\/{domain}\/app\/TicketCustomFields.List"
}

Endpoint

POST /app/TicketCustomFields.List
POST https://{user}.bull36.com/app/TicketCustomFields.List
POST https://{domain}/app/TicketCustomFields.List

Sample Output

{
    "success": 1,
    "count": 3,
    "data": [
        {
            "index": 0,
            "name": "a-1718960317",
            "type": "text",
            "en": "ORDER_ID",
            "he": "ORDER_ID",
            "require": "",
            "show_hide": "1"
        }
    ]
}

Count Only

Use the matching count route with the same filters when the UI only needs total rows for paging.

{
    "url": "\/app\/TicketCustomFields.Count",
    "url_user": "https:\/\/{user}.bull36.com\/app\/TicketCustomFields.Count",
    "url_domain": "https:\/\/{domain}\/app\/TicketCustomFields.Count",
    "method": "POST",
    "headers": {
        "Authorization": "Bearer YOUR TOKEN"
    },
    "body": [],
    "sample_output": {
        "success": 1,
        "count": 123
    },
    "notes": {
        "count": "Use the matching count route when available, or count returned rows.",
        "max_limit": 25
    }
}

Count JavaScript

const token = 'YOUR TOKEN';
const body = new URLSearchParams();

const res = await fetch('https://{domain}/app/TicketCustomFields.Count', {
  method: 'POST',
  headers: { Authorization: `Bearer ${token}` },
  body
});
const data = await res.json();
console.log(data.count);

JavaScript Example

const token = 'YOUR TOKEN';
const res = await fetch('/app/TicketCustomFields.List', { method: 'POST', headers: { Authorization: 'Bearer ' + token }, body: new URLSearchParams({ limit: '25' }) });
console.log(await res.json());

Error Example

{
    "success": 0,
    "message": "Organization not found."
}