Get Contacts

Endpoint

http

GET /unified/ticketing/contacts/{id}

Integrations supported

Accelo
BMC Helix
Dixa
eDesk
Enchant
Freshdesk
Front
FuseDesk
Gladly
Gorgias
Help Scout
HubSpot
Intercom
Jira Service Management
Kustomer
LiveAgent
LiveChat
Productboard
Puzzel Case Management
Quickbase for Project Management
Richpanel
Salesforce
ServiceNow
Superchat
SurveySparrow Ticket Management
Trengo
Zendesk
Zoho Desk

Path parameters

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.
debug returns the final unified result alongside raw remote fetch information. The response is an envelope containing result (identical to unified mode output) and debug (with requestUrl, requestOptions, data, responseHeaders, and for list operations: nextCursor, isLooping, isEmptyResult, resultCount). debug is null for static responses or when truto_skip_api_call=true.

Defaults to unified.

All possible enum values:

unified
raw
normalized
stream
debug

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

string

REQUIRED ·

The unique identifier for a contact

Supported in

Accelo
BMC Helix
Dixa
eDesk
Enchant
Freshdesk
Front
FuseDesk
Gladly
Gorgias
Help Scout
HubSpot
Intercom
Jira Service Management
Kustomer
LiveAgent
LiveChat
Productboard
Puzzel Case Management
Quickbase for Project Management
Richpanel
Salesforce
ServiceNow
servicenowitsm
Superchat
SurveySparrow Ticket Management
Trengo
Zendesk
Zoho Desk

first_name

string

The first name of the contact

Supported in

Accelo
BMC Helix
Dixa
Enchant
Freshdesk
FuseDesk
Gorgias
Help Scout
HubSpot
Intercom
LiveAgent
Richpanel
Salesforce
ServiceNow
servicenowitsm
Superchat
SurveySparrow Ticket Management
Zoho Desk

last_name

string

The last name of the contact

Supported in

Accelo
BMC Helix
Dixa
Enchant
Freshdesk
FuseDesk
Gorgias
Help Scout
HubSpot
Intercom
LiveAgent
Richpanel
Salesforce
ServiceNow
servicenowitsm
Superchat
SurveySparrow Ticket Management
Zoho Desk

name

string

The name of the contact

Supported in

Accelo
BMC Helix
Dixa
eDesk
Enchant
Freshdesk
Front
FuseDesk
Gladly
Gorgias
Help Scout
HubSpot
Intercom
Jira Service Management
Kustomer
LiveAgent
LiveChat
Productboard
Puzzel Case Management
Richpanel
Salesforce
ServiceNow
servicenowitsm
Superchat
SurveySparrow Ticket Management
Trengo
Zendesk
Zoho Desk

emails

object[]

The emails of the contact

Supported in

Accelo
BMC Helix
Dixa
eDesk
Enchant
Freshdesk
Front
FuseDesk
Gladly
Gorgias
Help Scout
HubSpot
Intercom
Jira Service Management
Kustomer
LiveAgent
LiveChat
Productboard
Puzzel Case Management
Richpanel
Salesforce
ServiceNow
servicenowitsm
Superchat
SurveySparrow Ticket Management
Trengo
Zendesk
Zoho Desk

string

REQUIRED ·

The email of the contact

type

string

The type of the email

phones

object[]

The phone numbers of the contact

Supported in

Accelo
BMC Helix
Dixa
eDesk
Enchant
Freshdesk
FuseDesk
Gladly
Gorgias
Help Scout
HubSpot
Intercom
Kustomer
LiveAgent
Puzzel Case Management
Richpanel
Salesforce
Superchat
SurveySparrow Ticket Management
Trengo
Zendesk
Zoho Desk

number

string

The phone of the contact

extension

string

The extension of the phone number

type

string

The type of the phone

details

string

The details of the contact

Supported in

Front
FuseDesk
Gorgias
Help Scout
Kustomer
Zendesk

account_id

string

The account id of the contact

Supported in

Accelo
BMC Helix
Freshdesk
Front
LiveAgent
Productboard
ServiceNow
Zoho Desk

created_at

string · date-time

The date the contact was created

Supported in

Accelo
BMC Helix
Dixa
Freshdesk
FuseDesk
Gladly
Gorgias
Help Scout
HubSpot
Intercom
Kustomer
LiveAgent
LiveChat
Richpanel
Salesforce
ServiceNow
servicenowitsm
Superchat
SurveySparrow Ticket Management
Zendesk
Zoho Desk

updated_at

string · date-time

The date the contact was last updated

Supported in

Accelo
BMC Helix
Freshdesk
Front
FuseDesk
Gladly
Gorgias
Help Scout
HubSpot
Intercom
Kustomer
LiveAgent
Richpanel
Salesforce
ServiceNow
servicenowitsm
Superchat
Zendesk

etag

string

The unique identifier for the specific version of the resource.

custom_fields

object

All the custom fields present on the contact

Supported in

Dixa
Front
Gladly
Kustomer
LiveAgent
Quickbase for Project Management
Salesforce
Superchat
Trengo

is_active

boolean

Whether the contact is active or not

Supported in

FuseDesk
Jira Service Management
ServiceNow
servicenowitsm
SurveySparrow Ticket Management
Zendesk

remote_data

object

Raw data returned from the remote API call.