POST

TicketCustomFields.Get

Load one ticket custom field definition. Dashboard uses array index (data_id / edit_id) and optional sub_data_id for a field inside a group. The API also accepts the storage name a-1731562297.

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 information as JSON for the UI.

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

  • Send the bearer token on protected calls with Authorization: Bearer YOUR TOKEN.
  • Send parameters as POST body fields exactly as documented.

Required Parameters

No body parameters are required for this function.

Optional Parameters

NameTypeSampleWhat it gives
name
post
stringa-1731562297Field storage id. Aliases: field_name, update_field_name.
edit_id
post
int0Top-level index in ticket_extra_fields (dashboard data_id). Alias: data_id.
sub_edit_id
post
int1Index inside group_data when editing a grouped field. Alias: sub_data_id.

Authentication

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

Authorization: Bearer YOUR TOKEN

Sample Request

{
    "url": "\/app\/TicketCustomFields.Get",
    "method": "POST",
    "headers": {
        "Authorization": "Bearer YOUR TOKEN"
    },
    "body": {
        "name": "a-1731562297"
    },
    "url_user": "https:\/\/{user}.bull36.com\/app\/TicketCustomFields.Get",
    "url_domain": "https:\/\/{domain}\/app\/TicketCustomFields.Get"
}

Endpoint

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

Sample Output

{
    "success": 1,
    "group_field_check": 0,
    "data": {
        "name": "a-1731562297",
        "type": "email",
        "en": "Email field",
        "he": "אימייל",
        "show_hide": "1"
    }
}

JavaScript Example

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

Error Example

{
    "success": 0,
    "message": "Ticket custom field not found."
}