List Contacts ​
Endpoint ​
GET /unified/ticketing/contacts
Integrations supported
- Accelo
- Enchant
- Freshdesk
- Gorgias
- Help Scout
- HubSpot
- Intercom
- Quickbase for Project Management
- Zendesk
- Zoho Desk
Partial response integrations
For partial response integrations, you will need to fetch the individual resource using the "get" endpoint to get the full response object.
- Gorgias
Query parameters ​
Refer Specifying query parameters in Truto APIs
The ID of the integrated account to use for the request.
62f44730-dd91-461e-bd6a-aedd9e0ad79d
The format of the response.
unified
will return the response with unified mappings applied.raw
will return the raw response from the remote API.normalized
will apply the unified mappings and return the data in a normalized format.
Defaults to unified
.
unified
raw
normalized
unified
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.
id
Ignores the limit
query parameter.
Excludes the remote_data
attribute from the response.
Array of fields to exclude from the response.
truto_exclude_fields[]=id&truto_exclude_fields[]=name
Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.
remote_query[foo]=bar
The name of the contact
Supported in
- Gorgias
Supported in
- Gorgias
The field to sort the resource by. Should be in format { fieldName: direction }
. The direction can be asc
or desc
.
Supported in
- Gorgias
The date the contact was created
asc
desc
Supported in
- Gorgias
The date the contact was last updated
asc
desc
Supported in
- Gorgias
Either one of emails or phones can be specified for filtering.
Supported in
- Accelo
- Enchant
- Gorgias
Either one of emails or phones can be specifiec for filtering.
Supported in
- Accelo
- Enchant
The date the contact was created
Supported in
- Accelo
The date the contact was last updated
Supported in
- Accelo
The first name of the contact
Supported in
- Accelo
The last name of the contact
Supported in
- Accelo
Response Body ​
List of Contacts
The unique identifier for a contact
Supported in
- Accelo
- Enchant
- Freshdesk
- Gorgias
- Help Scout
- HubSpot
- Intercom
- Quickbase for Project Management
- Zendesk
- Zoho Desk
The first name of the contact
Supported in
- Accelo
- Enchant
- Freshdesk
- Gorgias
- Help Scout
- HubSpot
- Intercom
- Zoho Desk
The last name of the contact
Supported in
- Accelo
- Enchant
- Freshdesk
- Gorgias
- Help Scout
- HubSpot
- Intercom
- Zoho Desk
The name of the contact
Supported in
- Accelo
- Enchant
- Freshdesk
- Gorgias
- Help Scout
- HubSpot
- Intercom
- Zendesk
- Zoho Desk
The emails of the contact
Supported in
- Accelo
- Enchant
- Freshdesk
- Gorgias
- Help Scout
- HubSpot
- Intercom
- Zendesk
- Zoho Desk
The email of the contact
The type of the email
The phone numbers of the contact
Supported in
- Accelo
- Enchant
- Freshdesk
- Help Scout
- HubSpot
- Intercom
- Zendesk
- Zoho Desk
The phone of the contact
The extension of the phone number
The type of the phone
The details of the contact
Supported in
- Gorgias
- Help Scout
- Zendesk
The account id of the contact
Supported in
- Accelo
- Freshdesk
- Zoho Desk
The date the contact was created
Supported in
- Accelo
- Freshdesk
- Gorgias
- Help Scout
- HubSpot
- Intercom
- Zendesk
- Zoho Desk
The date the contact was last updated
Supported in
- Accelo
- Freshdesk
- Gorgias
- Help Scout
- HubSpot
- Intercom
- Zendesk
The unique identifier for the specific version of the resource.
Raw data returned from the remote API call.
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.