Appearance

List Contacts ​

Endpoint ​

http
GET /unified/crm/contacts
Integrations supported
  • Capsule
  • Close
  • Copper
  • Highlevel
  • HubSpot
  • Outreach
  • Pipedrive
  • Salesforce
  • Zoho CRM

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
created_at
string · date-time
The date and time of the contact's creation
Supported in
  • Capsule
  • Salesforce
updated_at
string · date-time
The date and time of the contact's last update
Supported in
  • Capsule
  • Salesforce
email_addresses
array
Supported in
  • Salesforce

Response Body ​

result
object[]
List of Contacts
id
string
REQUIRED · The contact's unique identifier
Supported in
  • Capsule
  • Close
  • Copper
  • Highlevel
  • HubSpot
  • Outreach
  • Pipedrive
  • Salesforce
  • Zoho CRM
first_name
string
The contact's first name
Supported in
  • Close
  • Copper
  • Highlevel
  • HubSpot
  • Outreach
  • Pipedrive
  • Salesforce
  • Zoho CRM
last_name
string
The contact's last name
Supported in
  • Close
  • Copper
  • Highlevel
  • HubSpot
  • Outreach
  • Pipedrive
  • Salesforce
  • Zoho CRM
title
string
The contact's job title
Supported in
  • Close
  • Copper
  • HubSpot
  • Zoho CRM
account
object
The contact's account
Supported in
  • Close
  • Copper
  • Highlevel
  • HubSpot
  • Outreach
  • Pipedrive
  • Salesforce
  • Zoho CRM
id
string
The account's unique identifier
name
string
The account's name
addresses
object[]
Supported in
  • Capsule
  • Copper
  • Highlevel
  • HubSpot
  • Outreach
  • Salesforce
  • Zoho CRM
street_1
string
Line 1 of the street address
street_2
string
Line 2 of the street address
city
string
The city
state
string
The state
postal_code
string
The postal code
country
string
The country
type
string
The address type
email_addresses
object[]
Supported in
  • Close
  • Copper
  • Highlevel
  • HubSpot
  • Outreach
  • Pipedrive
  • Salesforce
  • Zoho CRM
email
string
The email address
type
string
The email address type
phone_numbers
object[]
Supported in
  • Capsule
  • Close
  • Copper
  • Highlevel
  • HubSpot
  • Outreach
  • Pipedrive
  • Salesforce
  • Zoho CRM
number
string
The phone number
type
string
The phone number type
tags
object[]
The contact's tags
Supported in
  • Copper
  • Highlevel
  • Zoho CRM
id
string
The tag's unique identifier
name
string
The tag's name
last_activity_at
string · date-time
The date and time of the contact's last activity
Supported in
  • Capsule
  • Copper
  • HubSpot
  • Outreach
  • Pipedrive
  • Salesforce
  • Zoho CRM
created_at
string · date-time
The date and time of the contact's creation
Supported in
  • Capsule
  • Close
  • Copper
  • Highlevel
  • HubSpot
  • Outreach
  • Pipedrive
  • Salesforce
  • Zoho CRM
updated_at
string · date-time
The date and time of the contact's last update
Supported in
  • Capsule
  • Close
  • Copper
  • Highlevel
  • HubSpot
  • Outreach
  • Pipedrive
  • Salesforce
  • Zoho CRM
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.