Appearance

Search Contacts ​

Endpoint ​

http
POST /unified/crm/contacts/search
Integrations supported
  • Close
  • HubSpot
  • Pipedrive
  • Salesforce

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
fields
string
The custom fields to return
Supported in
  • Close
  • HubSpot
  • Salesforce

Response Body ​

id
string
REQUIRED · The contact's unique identifier
Supported in
  • Close
  • HubSpot
  • Pipedrive
  • Salesforce
first_name
string
The contact's first name
Supported in
  • Close
  • HubSpot
  • Pipedrive
  • Salesforce
last_name
string
The contact's last name
Supported in
  • Close
  • HubSpot
  • Pipedrive
  • Salesforce
title
string
The contact's job title
Supported in
  • Close
  • HubSpot
account
object
The contact's account
Supported in
  • Close
  • HubSpot
  • Pipedrive
  • Salesforce
id
string
The account's unique identifier
name
string
The account's name
addresses
object[]
Supported in
  • HubSpot
  • Salesforce
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
  • HubSpot
  • Pipedrive
  • Salesforce
email
string
The email address
type
string
The email address type
phone_numbers
object[]
Supported in
  • Close
  • HubSpot
  • Pipedrive
  • Salesforce
number
string
The phone number
type
string
The phone number type
tags
object[]
The contact's tags
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
  • HubSpot
  • Salesforce
created_at
string · date-time
The date and time of the contact's creation
Supported in
  • Close
  • HubSpot
  • Salesforce
updated_at
string · date-time
The date and time of the contact's last update
Supported in
  • Close
  • HubSpot
  • Pipedrive
  • Salesforce
remote_data
object
Raw data returned from the remote API call.