Appearance

Get Fields ​

Endpoint ​

http
GET /unified/ticketing/fields/{id}
Integrations supported
  • Gorgias
  • Hive
  • Planhat
  • Salesforce
  • Teamwork Project Management
  • Trengo
  • Wrike

Path parameters ​

id
string
REQUIRED · 

The ID of the resource.

Example: 23423523

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_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

Response Body ​

id
string

The field's unique identifier

Supported in
  • Gorgias
  • Hive
  • Planhat
  • Salesforce
  • Teamwork Project Management
  • Trengo
  • Wrike
name
string

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

Supported in
  • Gorgias
  • Hive
  • Planhat
  • Salesforce
  • Teamwork Project Management
  • Trengo
  • Wrike
label
string

The field's label

Supported in
  • Gorgias
  • Hive
  • Planhat
  • Salesforce
  • Trengo
  • Wrike
description
string

The field's description

Supported in
  • Gorgias
  • Salesforce
  • Teamwork Project Management
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
  • Gorgias
  • Hive
  • Planhat
  • Salesforce
  • Teamwork Project Management
  • Trengo
  • Wrike
format
string

The field's format.

is_hidden
boolean

Whether the field is hidden

Supported in
  • Hive
  • Planhat
  • Teamwork Project Management
  • Wrike
is_unique
boolean

Whether the field is unique

Supported in
  • Salesforce
is_required
boolean

Whether the field is required

Supported in
  • Gorgias
  • Planhat
  • Salesforce
  • Teamwork Project Management
  • Trengo
options
object[]

The field's options

Supported in
  • Gorgias
  • Hive
  • Planhat
  • Salesforce
  • Trengo
  • Wrike
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
  • Gorgias
  • Trengo
entity_type
string

The entity type the field belongs to

All possible enum values:
  • ticket_type
  • ticket
  • collection
  • user
Supported in
  • Gorgias
  • Hive
  • Salesforce
  • Teamwork Project Management
  • Trengo
  • Wrike
entity_id
string

The unique identifier for the entity the field belongs to

Supported in
  • Wrike
created_at
string · date-time

The date and time of the field's creation

Supported in
  • Gorgias
  • Hive
  • Salesforce
  • Teamwork Project Management
updated_at
string · date-time

The date and time of the field's last update

Supported in
  • Gorgias
  • Hive
  • Salesforce
  • Teamwork Project Management
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
applicable_for
string

The unique identifier of the applicable

ticket_type
string

The ticket_type's unique identifier

status
string

The status of the field

All possible enum values:
  • active
  • archived
Supported in
  • Gorgias
remote_data
object

Raw data returned from the remote API call.