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.
- The user must be from the same company domain as the request Host (call the API on that account subdomain or allowed custom domain). A token from another company returns success=0, error user_not_in_company.
- 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.
- On a company subdomain (e.g. https://{user_domain}.bull36.com) the user must match that Host — Login and protected APIs reject another company with success=0, error user_not_in_company. On a main brand host (bull36.com, biz1.co.il, mastrocrm.com, …) the company domain gate is skipped.
- Send parameters as POST body fields exactly as documented.
Required Parameters
No body parameters are required for this function.
Optional Parameters
| Name | Type | Sample | What it gives |
|---|---|---|---|
namepost | string | a-1731562297 | Field storage id. Aliases: field_name, update_field_name. |
edit_idpost | int | 0 | Top-level index in ticket_extra_fields (dashboard data_id). Alias: data_id. |
sub_edit_idpost | int | 1 | Index inside group_data when editing a grouped field. Alias: sub_data_id. |
Authentication
Send the bearer token returned by Login in the request header. The user must be from the same company domain as this Host — a token from another company is rejected (user_not_in_company).
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.GetSample 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."
}