Skip to content
GET /unified/ticketing/fields

Query Parameters

Refer Specifying query parameters in Truto APIs

collectionsobject[]

Collections associated with the fields

3 supported2 required
Asana
required
Monday.com
required
Jira
supported
idstring
required·

The unique identifier for collection

entity_typestring

The entity to get the fields for

Possible values:
accountattachmentcollectioncommentcontactprojecttagticketticket_typeuser
21 supported13 required
Front
required
ticketcontactaccount
Gorgias
required
ticketcontact
HappyFox
required
ticketcontact
Help Scout
required
ticket
HubSpot
required
ticket
Jira
required
ticket_typeticket
Kustomer
required
ticketcontact
Quickbase for Project Management
required
accountattachmentcollectioncommentcontacttagticket
Salesforce
required
ticketcontactaccount
SurveySparrow Ticket Management
required
ticket
Zendesk
required
ticketcontact
Zoho Desk
required
ticketaccountcontact
Zoho Projects
required
projectticket
Freshdesk
supported
ticketcontactaccount
Dixa
supported
Hive
supported
Intercom
supported
Jira Service Management
supported
Teamwork Project Management
supported
Trengo
supported
Wrike
supported
workspaceobject
2 supported2 required2 notes
Help Scout
required

The workspace associated with the fields.

Jira Service Management
required

Fields associated with workspace.

idstring
required·

The unique identifier for workspace.

entity_idstring

The unique identifier for the entity the field belongs to

2 supported
Monday.com
supported
Wrike
supported
ticket_typestring

The ticket_type's unique identifier

4 supported1 required2 notes
Jira Service Management
required

Fields associated with ticket type.

Jira
supported

The unique identifier of the ticket_type.

Freshdesk
supported
Intercom
supported
sort_by
Possible values:
name
2 supported
Planhat
supported
Teamwork Project Management
supported
namestring

The field's name. This is the name of the property in the entity.

24 supported
Asana
supported
Dixa
supported
Freshdesk
supported
Front
supported
Gorgias
supported
HappyFox
supported
Help Scout
supported
Hive
supported
HubSpot
supported
Intercom
supported
Jira
supported
Jira Service Management
supported
Kustomer
supported
Monday.com
supported
Planhat
supported
Quickbase for Project Management
supported
Salesforce
supported
SurveySparrow Ticket Management
supported
Teamwork Project Management
supported
Trengo
supported
Wrike
supported
Zendesk
supported
Zoho Desk
supported
Zoho Projects
supported
organizationobject
1 supported
Zoho Projects
supported
idstring

The unique identifier for a organization.

Show Truto-specific parameters
integrated_account_idstring · uuid
required·

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_formatstring

The format of the response.

  • unified returns the response with unified mappings applied.
  • raw returns the unprocessed, raw response from the remote API.
  • normalized applies the unified mappings and returns the data in a normalized format.
  • stream returns the response as a stream, which is ideal for transmitting large datasets, files, or binary data. Using streaming mode helps to efficiently handle large payloads or real-time data flows without requiring the entire data to be buffered in memory.

Defaults to unified.

Example: unified
Possible values:
unifiedrawnormalizedstream
truto_key_bystring

By default the result attribute is an array of objects. This parameter allows you to specify a field in each result objects to use as key, which transforms the result array into an object with the array items keyed by the field. This is useful for when you want to use the result as a lookup table.

Example: id
truto_ignore_limitboolean

Ignores the limit query parameter.

truto_ignore_remote_databoolean

Excludes the remote_data attribute from the response.

truto_exclude_fieldsstring[]

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_queryRecord<string, any>

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar

Response Body

next_cursorstring

The cursor to use for the next page of results. Pass this value as next_cursor in the query parameter in the next request to get the next page of results.

resultobject[]

List of Fields

applicable_forstring

The unique identifier of the applicable

2 supported
Help Scout
supported
Intercom
supported
applicable_instring

The context in which the field is applicable

Possible values:
collectionworkspaceticket
3 supported
Help Scout
supported
Intercom
supported
SurveySparrow Ticket Management
supported
created_atstring · date-time

The date and time of the field's creation

10 supported
Dixa
supported
Freshdesk
supported
Gorgias
supported
Hive
supported
HubSpot
supported
Intercom
supported
Salesforce
supported
SurveySparrow Ticket Management
supported
Teamwork Project Management
supported
Zendesk
supported
descriptionstring

The field's description

13 supported
Dixa
supported
Freshdesk
supported
Front
supported
Gorgias
supported
HubSpot
supported
Intercom
supported
Jira
supported
Jira Service Management
supported
Monday.com
supported
Salesforce
supported
SurveySparrow Ticket Management
supported
Teamwork Project Management
supported
Zendesk
supported
entity_idstring

The unique identifier for the entity the field belongs to

2 supported
Monday.com
supported
Wrike
supported
entity_typestring

The entity type the field belongs to

Possible values:
ticket_typeticketcollectionuser
19 supported
Dixa
supported
Freshdesk
supported
Front
supported
Gorgias
supported
HappyFox
supported
Help Scout
supported
Hive
supported
HubSpot
supported
Intercom
supported
Jira
supported
Jira Service Management
supported
Kustomer
supported
Quickbase for Project Management
supported
Salesforce
supported
SurveySparrow Ticket Management
supported
Teamwork Project Management
supported
Trengo
supported
Wrike
supported
Zendesk
supported
etagstring

The unique identifier for the specific version of the resource.

formatstring

The field's format.

2 supported
Jira
supported
Jira Service Management
supported
idstring

The field's unique identifier

24 supported
Asana
supported
Dixa
supported
Freshdesk
supported
Front
supported
Gorgias
supported
HappyFox
supported
Help Scout
supported
Hive
supported
HubSpot
supported
Intercom
supported
Jira
supported
Jira Service Management
supported
Kustomer
supported
Monday.com
supported
Planhat
supported
Quickbase for Project Management
supported
Salesforce
supported
SurveySparrow Ticket Management
supported
Teamwork Project Management
supported
Trengo
supported
Wrike
supported
Zendesk
supported
Zoho Desk
supported
Zoho Projects
supported
is_hiddenboolean

Whether the field is hidden

9 supported
Dixa
supported
Hive
supported
HubSpot
supported
Planhat
supported
Quickbase for Project Management
supported
Teamwork Project Management
supported
Wrike
supported
Zendesk
supported
Zoho Projects
supported
is_requiredboolean

Whether the field is required

16 supported
Dixa
supported
Freshdesk
supported
Gorgias
supported
HappyFox
supported
Help Scout
supported
Intercom
supported
Jira
supported
Jira Service Management
supported
Planhat
supported
Quickbase for Project Management
supported
SurveySparrow Ticket Management
supported
Teamwork Project Management
supported
Trengo
supported
Zendesk
supported
Zoho Desk
supported
Zoho Projects
supported
is_uniqueboolean

Whether the field is unique

2 supported
HubSpot
supported
Quickbase for Project Management
supported
is_user_definedboolean

Whether the field is user defined

14 supported
Freshdesk
supported
Gorgias
supported
HappyFox
supported
Help Scout
supported
HubSpot
supported
Intercom
supported
Jira
supported
Jira Service Management
supported
Kustomer
supported
Salesforce
supported
SurveySparrow Ticket Management
supported
Trengo
supported
Zendesk
supported
Zoho Desk
supported
labelstring

The field's label

23 supported
Asana
supported
Dixa
supported
Freshdesk
supported
Front
supported
Gorgias
supported
HappyFox
supported
Help Scout
supported
Hive
supported
HubSpot
supported
Intercom
supported
Jira
supported
Jira Service Management
supported
Kustomer
supported
Monday.com
supported
Planhat
supported
Quickbase for Project Management
supported
Salesforce
supported
SurveySparrow Ticket Management
supported
Trengo
supported
Wrike
supported
Zendesk
supported
Zoho Desk
supported
Zoho Projects
supported
namestring

The field's name. This is the name of the property in the entity.

24 supported
Asana
supported
Dixa
supported
Freshdesk
supported
Front
supported
Gorgias
supported
HappyFox
supported
Help Scout
supported
Hive
supported
HubSpot
supported
Intercom
supported
Jira
supported
Jira Service Management
supported
Kustomer
supported
Monday.com
supported
Planhat
supported
Quickbase for Project Management
supported
Salesforce
supported
SurveySparrow Ticket Management
supported
Teamwork Project Management
supported
Trengo
supported
Wrike
supported
Zendesk
supported
Zoho Desk
supported
Zoho Projects
supported
optionsobject[]

The field's options

20 supported
Asana
supported
Dixa
supported
Freshdesk
supported
Front
supported
Gorgias
supported
HappyFox
supported
Help Scout
supported
Hive
supported
HubSpot
supported
Jira
supported
Jira Service Management
supported
Kustomer
supported
Monday.com
supported
Planhat
supported
SurveySparrow Ticket Management
supported
Trengo
supported
Wrike
supported
Zendesk
supported
Zoho Desk
supported
Zoho Projects
supported
4 properties
descriptionstring

The option's description

is_hiddenboolean

Whether the option is hidden

labelstring

The option's label

valuestring

The option's value

remote_dataRecord<string, any>

Raw data returned from the remote API call.

statusstring

The status of the field

Possible values:
activearchived
8 supported
Dixa
supported
Front
supported
Gorgias
supported
HappyFox
supported
Intercom
supported
Kustomer
supported
Monday.com
supported
Zendesk
supported
ticket_typestring

The ticket_type's unique identifier

4 supported
Freshdesk
supported
Intercom
supported
Jira
supported
Jira Service Management
supported
typestring

The field's type. If no clear mapping exists, then raw value is returned.

Possible values:
stringtextrich_textnumberbooleandatedatetimetimeenumarrayfile
24 supported
Asana
supported
Dixa
supported
Freshdesk
supported
Front
supported
Gorgias
supported
HappyFox
supported
Help Scout
supported
Hive
supported
HubSpot
supported
Intercom
supported
Jira
supported
Jira Service Management
supported
Kustomer
supported
Monday.com
supported
Planhat
supported
Quickbase for Project Management
supported
Salesforce
supported
SurveySparrow Ticket Management
supported
Teamwork Project Management
supported
Trengo
supported
Wrike
supported
Zendesk
supported
Zoho Desk
supported
Zoho Projects
supported
updated_atstring · date-time

The date and time of the field's last update

11 supported
Dixa
supported
Freshdesk
supported
Gorgias
supported
Hive
supported
HubSpot
supported
Intercom
supported
Kustomer
supported
Salesforce
supported
SurveySparrow Ticket Management
supported
Teamwork Project Management
supported
Zendesk
supported
curl -X GET 'https://api.truto.one/unified/ticketing/fields?integrated_account_id=<integrated_account_id>' \
  -H 'Authorization: Bearer <your_api_token>' \
  -H 'Content-Type: application/json'
const integratedAccountId = '<integrated_account_id>';

const response = await fetch(`https://api.truto.one/unified/ticketing/fields?integrated_account_id=${integratedAccountId}`, {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer <your_api_token>',
    'Content-Type': 'application/json',
  },
});

const data = await response.json();
console.log(data);
import requests

url = "https://api.truto.one/unified/ticketing/fields"
headers = {
    "Authorization": "Bearer <your_api_token>",
    "Content-Type": "application/json",
}
params = {
    "integrated_account_id": "<integrated_account_id>"
}

response = requests.get(url, headers=headers, params=params)
print(response.json())
import Truto from '@truto/truto-ts-sdk';

const truto = new Truto({
  token: '<your_api_token>',
});

const result = await truto.unifiedApi.list(
  'ticketing',
  'fields',
  { integrated_account_id: '<integrated_account_id>' }
);

console.log(result);
import asyncio
from truto_python_sdk import TrutoApi

truto_api = TrutoApi(token="<your_api_token>")

async def main():
    async for item in truto_api.unified_api.list(
        "ticketing",
        "fields",
        {"integrated_account_id": "<integrated_account_id>"}
    ):
        print(item)

asyncio.run(main())