Skip to main content

Search Contact

Search Contact
GET

Search contact records using one or more supported filters.

Request

GET

GET /v1/contact/search

Headers

  • Authorization: Bearer your_access_token

Query Parameters

ParameterTypeDescription
contact_slugstringDirect lookup by contact slug. Takes priority over other filters when provided.
first_namestringContact first name.
last_namestringContact last name.
emailstringContact email address.
phonestringContact phone number.
linkedin_urlstringContact LinkedIn URL.
organization_slugstringOrganization slug connected to the contact.
owner_idintegerOwner user ID.
owner_namestringOwner full name.
owner_emailstringOwner email address.
created_fromISO 8601 timestampReturn contacts created at or after this timestamp.
created_toISO 8601 timestampReturn contacts created at or before this timestamp.
updated_fromISO 8601 timestampReturn contacts updated at or after this timestamp.
updated_toISO 8601 timestampReturn contacts updated at or before this timestamp.
exact_searchboolean stringUse true for exact text matching. Default: partial matching.
sort_bystringAllowed values: created_at, updated_at. Default: updated_at.
sort_orderstringAllowed values: asc, desc. Default: desc.
maximizestringComma-separated response expansions. Use all to expand all supported contact fields.
pageintegerPage number. Default: 1.
limitintegerRecords per page. Default: 25. Requests above 50 are capped at 50.

Search Behavior

  • Include at least one search filter to receive results.
  • contact_slug performs a direct lookup and takes priority over all other filters.
  • Text filters use partial matching by default. Pass exact_search=true for exact text matching.
  • Date range filters are inclusive. For each date range, the *_to value must be greater than or equal to the matching *_from value.
  • Results are sorted by updated_at in descending order unless sorting parameters are provided.

Supported maximize values

owner, created_by, updated_by, organization, stage, all

Request Examples

Search by name

GET /v1/contact/search?first_name=Anjali&last_name=Kotwani
GET /v1/contact/search?email=anjali@example.com&exact_search=true

Search by organization

GET /v1/contact/search?organization_slug=organization_d1d6d8323f07a6615f95&maximize=organization

Search by owner

GET /v1/contact/search?owner_name=Rohan%20Sharma&maximize=owner

Direct slug lookup

GET /v1/contact/search?contact_slug=contact_68ba678fcd2a83f4640c

Response

200
{
"total": 1,
"per_page": 25,
"current_page": 1,
"last_page": 1,
"next_page_url": null,
"prev_page_url": null,
"from": 1,
"to": 1,
"data": [
{
"id": 28,
"first_name": "Anjali",
"last_name": "Kotwani",
"slug": "contact_68ba678fcd2a83f4640c",
"full_name": "Anjali Kotwani",
"email": "anjali@example.com",
"phone": "+14155550100",
"organization": {
"id": 12
},
"created_at": "2026-06-21T02:49:00.000Z",
"updated_at": "2026-07-08T17:47:00.000Z"
}
]
}
400
[
{
"field_name": "created_to",
"error_message": "created_to must be greater than or equal to created_from"
}
]