Appearance

List Fields ​

Endpoint ​

http
GET /unified/ticketing/fields
Integrations supported
  • Asana
  • Dixa
  • Freshdesk
  • Front
  • Gorgias
  • Happyfox
  • Hive
  • HubSpot
  • Intercom
  • Jira
  • Jira Service Management
  • Monday.com
  • Planhat
  • Quickbase for Project Management
  • Teamwork Project Management
  • Wrike
  • Zendesk
  • Zoho Projects

Query parameters ​

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · 

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

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string

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.

All possible enum values:
  • unified
  • raw
  • normalized
  • stream
Example: unified
truto_key_by
string

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_limit
boolean

Ignores the limit query parameter.

truto_ignore_remote_data
boolean

Excludes the remote_data attribute from the response.

truto_exclude_fields
array

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object

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
entity_type
string

The entity to get the fields for

All possible enum values:
  • account
  • attachment
  • collection
  • comment
  • contact
  • project
  • tag
  • ticket
  • ticket_type
  • user
Enum support by integration
  • Jira
    • ticket_type
    • ticket
  • Quickbase for Project Management
    • account
    • attachment
    • collection
    • comment
    • contact
    • tag
    • ticket
  • Zoho Projects
    • project
    • ticket
  • HubSpot
    • ticket
  • Gorgias
    • ticket
    • contact
  • Freshdesk
    • ticket
  • Happyfox
    • ticket
    • contact
  • Zendesk
    • ticket
    • contact
  • Front
    • ticket
    • contact
    • account
  • Jira Service Management
    • ticket
Required in
  • Front
  • Gorgias
  • Happyfox
  • HubSpot
  • Jira
  • Jira Service Management
  • Quickbase for Project Management
  • Zendesk
  • Zoho Projects
Supported in
  • Freshdesk
entity_id
string

The unique identifier for the entity the field belongs to

Supported in
  • Jira
collections
array

Collections associated with the fields

Required in
  • Asana
  • Monday.com
Supported in
  • Jira
ticket_type
string

The ticket_type's unique identifier

Integration specific notes
  • JiraThe unique identifier of the ticket_type.
  • Jira Service ManagementFields associated with ticket type.
Required in
  • Jira Service Management
Supported in
  • Jira
name
string

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

Supported in
  • Teamwork Project Management
sort_by

The field to sort the resource by. Should be in format { fieldName: direction }. The direction can be asc or desc.

All possible enum values:
  • name
Supported in
  • Planhat
  • Teamwork Project Management
organization
object
Supported in
  • Zoho Projects
id
string

The unique identifier for a organization.

workspace
object

Fields associated with workspace.

Required in
  • Jira Service Management
id
string
REQUIRED · 

The unique identifier for workspace.

Response Body ​

result
object[]

List of Fields

id
string

The field's unique identifier

Supported in
  • Asana
  • Dixa
  • Freshdesk
  • Front
  • Gorgias
  • Happyfox
  • Hive
  • HubSpot
  • Intercom
  • Jira
  • Jira Service Management
  • Monday.com
  • Planhat
  • Quickbase for Project Management
  • Teamwork Project Management
  • Wrike
  • Zendesk
  • Zoho Projects
name
string

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

Supported in
  • Asana
  • Dixa
  • Freshdesk
  • Front
  • Gorgias
  • Happyfox
  • Hive
  • HubSpot
  • Intercom
  • Jira
  • Jira Service Management
  • Monday.com
  • Planhat
  • Quickbase for Project Management
  • Teamwork Project Management
  • Wrike
  • Zendesk
  • Zoho Projects
label
string

The field's label

Supported in
  • Asana
  • Dixa
  • Freshdesk
  • Front
  • Gorgias
  • Happyfox
  • Hive
  • HubSpot
  • Intercom
  • Jira
  • Jira Service Management
  • Monday.com
  • Planhat
  • Quickbase for Project Management
  • Wrike
  • Zendesk
  • Zoho Projects
description
string

The field's description

Supported in
  • Dixa
  • Freshdesk
  • Front
  • Gorgias
  • HubSpot
  • Intercom
  • Jira
  • Jira Service Management
  • Monday.com
  • Teamwork Project Management
  • Zendesk
type
string

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

All possible enum values:
  • string
  • text
  • rich_text
  • number
  • boolean
  • date
  • datetime
  • time
  • enum
  • array
  • file
Supported in
  • Asana
  • Dixa
  • Freshdesk
  • Front
  • Gorgias
  • Happyfox
  • Hive
  • HubSpot
  • Intercom
  • Jira
  • Jira Service Management
  • Monday.com
  • Planhat
  • Quickbase for Project Management
  • Teamwork Project Management
  • Wrike
  • Zendesk
  • Zoho Projects
format
string

The field's format.

Supported in
  • Jira
is_hidden
boolean

Whether the field is hidden

Supported in
  • Dixa
  • Hive
  • HubSpot
  • Planhat
  • Quickbase for Project Management
  • Teamwork Project Management
  • Wrike
  • Zendesk
  • Zoho Projects
is_unique
boolean

Whether the field is unique

Supported in
  • HubSpot
  • Quickbase for Project Management
is_required
boolean

Whether the field is required

Supported in
  • Dixa
  • Freshdesk
  • Gorgias
  • Happyfox
  • Intercom
  • Jira
  • Jira Service Management
  • Planhat
  • Quickbase for Project Management
  • Teamwork Project Management
  • Zendesk
  • Zoho Projects
options
object[]

The field's options

Supported in
  • Asana
  • Dixa
  • Freshdesk
  • Front
  • Gorgias
  • Happyfox
  • Hive
  • HubSpot
  • Jira
  • Jira Service Management
  • Monday.com
  • Planhat
  • Wrike
  • Zendesk
  • Zoho Projects
label
string

The option's label

value
string

The option's value

description
string

The option's description

is_hidden
boolean

Whether the option is hidden

is_user_defined
boolean

Whether the field is user defined

Supported in
  • Freshdesk
  • Gorgias
  • Happyfox
  • HubSpot
  • Intercom
  • Jira
  • Jira Service Management
  • Zendesk
entity_type
string

The entity type the field belongs to

All possible enum values:
  • ticket_type
  • ticket
  • collection
  • user
Supported in
  • Dixa
  • Freshdesk
  • Front
  • Gorgias
  • Happyfox
  • Hive
  • HubSpot
  • Intercom
  • Jira
  • Jira Service Management
  • Quickbase for Project Management
  • Teamwork Project Management
  • Wrike
  • Zendesk
entity_id
string

The unique identifier for the entity the field belongs to

Supported in
  • Monday.com
  • Wrike
created_at
string · date-time

The date and time of the field's creation

Supported in
  • Dixa
  • Freshdesk
  • Gorgias
  • Hive
  • HubSpot
  • Intercom
  • Teamwork Project Management
  • Zendesk
updated_at
string · date-time

The date and time of the field's last update

Supported in
  • Dixa
  • Freshdesk
  • Gorgias
  • Hive
  • HubSpot
  • Intercom
  • Teamwork Project Management
  • Zendesk
etag
string

The unique identifier for the specific version of the resource.

applicable_in
string

The context in which the field is applicable

All possible enum values:
  • collection
  • workspace
  • ticket
Supported in
  • Intercom
applicable_for
string

The unique identifier of the applicable

Supported in
  • Intercom
ticket_type
string

The ticket_type's unique identifier

Supported in
  • Freshdesk
  • Intercom
  • Jira
  • Jira Service Management
remote_data
object

Raw data returned from the remote API call.

next_cursor
string

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.