Search contacts
string
Matches the name, phone number, email, company, or notes. Up to 100 characters.
integer
default:"10"
Results per page, 1 to 50.
integer
default:"1"
Page number. Use
next_page from the previous response.Contact fields
integer
The contact ID.
string
The contact in the dashboard.
string | null
The customer’s name, when known.
string | null
Phone number.
string | null
Email address.
string | null
Company name.
string | null
The contact’s stage, when your team sets one.
string[]
Tags on the contact. Empty when there are none.
string | null
Notes on the contact. Up to 2,000 characters.
boolean
true when the contact is blocked.integer
How many phone calls with this contact the key can see, inbound and outbound. Texts, chats, and emails that started on their own are not counted. Spam and unanswered calls are not counted.
string | null
When the contact record was created, as an ISO 8601 UTC timestamp. Despite the name, it is not read from the contact’s conversations.
string | null
When the contact’s latest phone call or website chat handoff started. Texts and emails do not change it.
null when that conversation was spam or unanswered, or is on a phone line the key cannot see.Get a contact
integer
required
The contact ID.
object[]
Up to 10 conversations, most recent activity first, in the conversation format.
404.