Skip to content

List Contacts

Endpoint

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

Query parameters

integrated_account_id
string · uuid
REQUIRED · The ID of the integrated account to use for the request.
Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
name
string
The name of the contact
Supported in
  • Gorgias
email
Supported in
  • Gorgias

Response Body

result
object[]
List of Contacts
id
string
REQUIRED · The unique identifier for a contact
Supported in
  • Freshdesk
  • Gorgias
  • Help Scout
  • Intercom
  • Zendesk
first_name
string
The first name of the contact
Supported in
  • Freshdesk
  • Gorgias
  • Help Scout
  • Intercom
last_name
string
The last name of the contact
Supported in
  • Freshdesk
  • Gorgias
  • Help Scout
  • Intercom
name
string
The name of the contact
Supported in
  • Freshdesk
  • Gorgias
  • Help Scout
  • Intercom
  • Zendesk
emails
object[]
The emails of the contact
Supported in
  • Freshdesk
  • Gorgias
  • Help Scout
  • 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
  • Freshdesk
  • Help Scout
  • Intercom
  • Zendesk
number
string
The phone of the contact
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
  • Freshdesk
created_at
string
The date the contact was created
Supported in
  • Freshdesk
  • Gorgias
  • Help Scout
  • Intercom
  • Zendesk
updated_at
string
The date the contact was last updated
Supported in
  • Freshdesk
  • Gorgias
  • Help Scout
  • 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.