Skip to content
GET /unified/ticketing/contacts

Partial response — use the "get" endpoint for the full object.

Query Parameters

Refer Specifying query parameters in Truto APIs

emailsobject[]

Either one of emails or phones can be specified for filtering.

29 supported
Accelo
supported
BMC Helix
supported
Dixa
supported
eDesk
supported
Enchant
supported
Freshdesk
supported
Front
supported
FuseDesk
supported
Gorgias
supported
Help Scout
supported
HubSpot
supported
Intercom
supported
Jira Service Management
supported
Kustomer
supported
LiveAgent
supported
LiveChat
supported
Podium
supported
Productboard
supported
Puzzel Case Management
supported
Re:amaze
supported
Salesforce
supported
ServiceNow
supported
servicenowitsm
supported
Superchat
supported
SurveySparrow Ticket Management
supported
Trengo
supported
Truto Test
supported
Zendesk
supported
Zoho Desk
supported
emailstring
required·

The email of the contact

typestring

The type of the email

phonesobject[]

Either one of emails or phones can be specifiec for filtering.

22 supported
Accelo
supported
BMC Helix
supported
Dixa
supported
eDesk
supported
Enchant
supported
Freshdesk
supported
FuseDesk
supported
Help Scout
supported
HubSpot
supported
Intercom
supported
Kustomer
supported
LiveAgent
supported
Podium
supported
Puzzel Case Management
supported
Re:amaze
supported
Salesforce
supported
Superchat
supported
SurveySparrow Ticket Management
supported
Trengo
supported
Truto Test
supported
Zendesk
supported
Zoho Desk
supported
extensionstring

The extension of the phone number

numberstring

The phone of the contact

typestring

The type of the phone

created_atstring · date-time

The date the contact was created

22 supported
Accelo
supported
BMC Helix
supported
Dixa
supported
Freshdesk
supported
FuseDesk
supported
Gorgias
supported
Help Scout
supported
HubSpot
supported
Intercom
supported
Kustomer
supported
LiveAgent
supported
LiveChat
supported
Podium
supported
Re:amaze
supported
Salesforce
supported
ServiceNow
supported
servicenowitsm
supported
Superchat
supported
SurveySparrow Ticket Management
supported
Truto Test
supported
Zendesk
supported
Zoho Desk
supported
updated_atstring · date-time

The date the contact was last updated

19 supported
Accelo
supported
BMC Helix
supported
Freshdesk
supported
Front
supported
FuseDesk
supported
Gorgias
supported
Help Scout
supported
HubSpot
supported
Intercom
supported
Kustomer
supported
LiveAgent
supported
Podium
supported
Re:amaze
supported
Salesforce
supported
ServiceNow
supported
servicenowitsm
supported
Superchat
supported
Truto Test
supported
Zendesk
supported
first_namestring

The first name of the contact

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

The last name of the contact

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

The account id of the contact

8 supported
Accelo
supported
BMC Helix
supported
Freshdesk
supported
Front
supported
LiveAgent
supported
Productboard
supported
ServiceNow
supported
Zoho Desk
supported
search_term
4 supported1 required
FuseDesk
required
Help Scout
supported
SurveySparrow Ticket Management
supported
Trengo
supported
namestring

The name of the contact

29 supported
Accelo
supported
BMC Helix
supported
Dixa
supported
eDesk
supported
Enchant
supported
Freshdesk
supported
Front
supported
FuseDesk
supported
Gorgias
supported
Help Scout
supported
HubSpot
supported
Intercom
supported
Jira Service Management
supported
Kustomer
supported
LiveAgent
supported
LiveChat
supported
Podium
supported
Productboard
supported
Puzzel Case Management
supported
Re:amaze
supported
Salesforce
supported
ServiceNow
supported
servicenowitsm
supported
Superchat
supported
SurveySparrow Ticket Management
supported
Trengo
supported
Truto Test
supported
Zendesk
supported
Zoho Desk
supported
sort_byobject
Possible values:
created_atfirst_namelast_nameupdated_at
3 supported
Help Scout
supported
first_namelast_nameupdated_atcreated_at
LiveChat
supported
created_at
Gorgias
supported
created_atstring · date-time

The date the contact was created

Possible values:
ascdesc
1 supported
Gorgias
supported
updated_atstring · date-time

The date the contact was last updated

Possible values:
ascdesc
1 supported
Gorgias
supported
channelsobject
1 supported
Gorgias
supported
addressstring
typestring
Possible values:
instagramtwitter
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 Contacts

idstring
required·

The unique identifier for a contact

30 supported
Accelo
supported
BMC Helix
supported
Dixa
supported
eDesk
supported
Enchant
supported
Freshdesk
supported
Front
supported
FuseDesk
supported
Gorgias
supported
Help Scout
supported
HubSpot
supported
Intercom
supported
Jira Service Management
supported
Kustomer
supported
LiveAgent
supported
LiveChat
supported
Podium
supported
Productboard
supported
Puzzel Case Management
supported
Quickbase for Project Management
supported
Re:amaze
supported
Salesforce
supported
ServiceNow
supported
servicenowitsm
supported
Superchat
supported
SurveySparrow Ticket Management
supported
Trengo
supported
Truto Test
supported
Zendesk
supported
Zoho Desk
supported
account_idstring

The account id of the contact

8 supported
Accelo
supported
BMC Helix
supported
Freshdesk
supported
Front
supported
LiveAgent
supported
Productboard
supported
ServiceNow
supported
Zoho Desk
supported
created_atstring · date-time

The date the contact was created

22 supported
Accelo
supported
BMC Helix
supported
Dixa
supported
Freshdesk
supported
FuseDesk
supported
Gorgias
supported
Help Scout
supported
HubSpot
supported
Intercom
supported
Kustomer
supported
LiveAgent
supported
LiveChat
supported
Podium
supported
Re:amaze
supported
Salesforce
supported
ServiceNow
supported
servicenowitsm
supported
Superchat
supported
SurveySparrow Ticket Management
supported
Truto Test
supported
Zendesk
supported
Zoho Desk
supported
custom_fieldsRecord<string, any>

All the custom fields present on the contact

9 supported
Dixa
supported
Front
supported
Kustomer
supported
LiveAgent
supported
Quickbase for Project Management
supported
Re:amaze
supported
Salesforce
supported
Superchat
supported
Trengo
supported
detailsstring

The details of the contact

8 supported
Front
supported
FuseDesk
supported
Gorgias
supported
Help Scout
supported
Kustomer
supported
Podium
supported
Re:amaze
supported
Zendesk
supported
emailsobject[]

The emails of the contact

29 supported
Accelo
supported
BMC Helix
supported
Dixa
supported
eDesk
supported
Enchant
supported
Freshdesk
supported
Front
supported
FuseDesk
supported
Gorgias
supported
Help Scout
supported
HubSpot
supported
Intercom
supported
Jira Service Management
supported
Kustomer
supported
LiveAgent
supported
LiveChat
supported
Podium
supported
Productboard
supported
Puzzel Case Management
supported
Re:amaze
supported
Salesforce
supported
ServiceNow
supported
servicenowitsm
supported
Superchat
supported
SurveySparrow Ticket Management
supported
Trengo
supported
Truto Test
supported
Zendesk
supported
Zoho Desk
supported
2 properties
emailstring
required·

The email of the contact

typestring

The type of the email

etagstring

The unique identifier for the specific version of the resource.

first_namestring

The first name of the contact

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

Whether the contact is active or not

6 supported
FuseDesk
supported
Jira Service Management
supported
ServiceNow
supported
servicenowitsm
supported
SurveySparrow Ticket Management
supported
Zendesk
supported
last_namestring

The last name of the contact

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

The name of the contact

29 supported
Accelo
supported
BMC Helix
supported
Dixa
supported
eDesk
supported
Enchant
supported
Freshdesk
supported
Front
supported
FuseDesk
supported
Gorgias
supported
Help Scout
supported
HubSpot
supported
Intercom
supported
Jira Service Management
supported
Kustomer
supported
LiveAgent
supported
LiveChat
supported
Podium
supported
Productboard
supported
Puzzel Case Management
supported
Re:amaze
supported
Salesforce
supported
ServiceNow
supported
servicenowitsm
supported
Superchat
supported
SurveySparrow Ticket Management
supported
Trengo
supported
Truto Test
supported
Zendesk
supported
Zoho Desk
supported
phonesobject[]

The phone numbers of the contact

22 supported
Accelo
supported
BMC Helix
supported
Dixa
supported
eDesk
supported
Enchant
supported
Freshdesk
supported
FuseDesk
supported
Help Scout
supported
HubSpot
supported
Intercom
supported
Kustomer
supported
LiveAgent
supported
Podium
supported
Puzzel Case Management
supported
Re:amaze
supported
Salesforce
supported
Superchat
supported
SurveySparrow Ticket Management
supported
Trengo
supported
Truto Test
supported
Zendesk
supported
Zoho Desk
supported
3 properties
extensionstring

The extension of the phone number

numberstring

The phone of the contact

typestring

The type of the phone

remote_dataRecord<string, any>

Raw data returned from the remote API call.

updated_atstring · date-time

The date the contact was last updated

19 supported
Accelo
supported
BMC Helix
supported
Freshdesk
supported
Front
supported
FuseDesk
supported
Gorgias
supported
Help Scout
supported
HubSpot
supported
Intercom
supported
Kustomer
supported
LiveAgent
supported
Podium
supported
Re:amaze
supported
Salesforce
supported
ServiceNow
supported
servicenowitsm
supported
Superchat
supported
Truto Test
supported
Zendesk
supported
curl -X GET 'https://api.truto.one/unified/ticketing/contacts?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/contacts?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/contacts"
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',
  'contacts',
  { 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",
        "contacts",
        {"integrated_account_id": "<integrated_account_id>"}
    ):
        print(item)

asyncio.run(main())