Skip to content

List Contacts

Endpoint

http
GET /unified/ticketing/contacts
Integrations supported
  • Accelo
  • Enchant
  • Freshdesk
  • Gorgias
  • Help Scout
  • HubSpot
  • Intercom
  • Zendesk

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

All possible enum values:
  • unified
  • raw
  • normalized
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
name
string

The name of the contact

Supported in
  • Gorgias
email
Supported in
  • Gorgias
sort_by
object

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

Supported in
  • Gorgias
created_at
string · date-time

The date the contact was created

All possible enum values:
  • asc
  • desc
Supported in
  • Gorgias
updated_at
string · date-time

The date the contact was last updated

All possible enum values:
  • asc
  • desc
Supported in
  • Gorgias
emails
array

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

Supported in
  • Accelo
  • Enchant
phones
array

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

Supported in
  • Accelo
  • Enchant
created_at
string · date-time

The date the contact was created

Supported in
  • Accelo
updated_at
string · date-time

The date the contact was last updated

Supported in
  • Accelo
first_name
string

The first name of the contact

Supported in
  • Accelo
last_name
string

The last name of the contact

Supported in
  • Accelo

Response Body

result
object[]

List of Contacts

id
string
REQUIRED · 

The unique identifier for a contact

Supported in
  • Accelo
  • Enchant
  • Freshdesk
  • Gorgias
  • Help Scout
  • HubSpot
  • Intercom
  • Zendesk
first_name
string

The first name of the contact

Supported in
  • Accelo
  • Enchant
  • Freshdesk
  • Gorgias
  • Help Scout
  • HubSpot
  • Intercom
last_name
string

The last name of the contact

Supported in
  • Accelo
  • Enchant
  • Freshdesk
  • Gorgias
  • Help Scout
  • HubSpot
  • Intercom
name
string

The name of the contact

Supported in
  • Accelo
  • Enchant
  • Freshdesk
  • Gorgias
  • Help Scout
  • HubSpot
  • Intercom
  • Zendesk
emails
object[]

The emails of the contact

Supported in
  • Accelo
  • Enchant
  • Freshdesk
  • Gorgias
  • Help Scout
  • HubSpot
  • Intercom
  • Zendesk
email
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
  • Enchant
  • Freshdesk
  • Help Scout
  • HubSpot
  • Intercom
  • Zendesk
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
  • Gorgias
  • Help Scout
  • Zendesk
account_id
string

The account id of the contact

Supported in
  • Accelo
  • Freshdesk
created_at
string · date-time

The date the contact was created

Supported in
  • Accelo
  • Freshdesk
  • Gorgias
  • Help Scout
  • HubSpot
  • Intercom
  • Zendesk
updated_at
string · date-time

The date the contact was last updated

Supported in
  • Accelo
  • Freshdesk
  • Gorgias
  • Help Scout
  • HubSpot
  • Intercom
  • Zendesk
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.