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
| Parameter | Type | Description |
|---|---|---|
contact_slug | string | Direct lookup by contact slug. Takes priority over other filters when provided. |
first_name | string | Contact first name. |
last_name | string | Contact last name. |
email | string | Contact email address. |
phone | string | Contact phone number. |
linkedin_url | string | Contact LinkedIn URL. |
organization_slug | string | Organization slug connected to the contact. |
owner_id | integer | Owner user ID. |
owner_name | string | Owner full name. |
owner_email | string | Owner email address. |
created_from | ISO 8601 timestamp | Return contacts created at or after this timestamp. |
created_to | ISO 8601 timestamp | Return contacts created at or before this timestamp. |
updated_from | ISO 8601 timestamp | Return contacts updated at or after this timestamp. |
updated_to | ISO 8601 timestamp | Return contacts updated at or before this timestamp. |
exact_search | boolean string | Use true for exact text matching. Default: partial matching. |
sort_by | string | Allowed values: created_at, updated_at. Default: updated_at. |
sort_order | string | Allowed values: asc, desc. Default: desc. |
maximize | string | Comma-separated response expansions. Use all to expand all supported contact fields. |
page | integer | Page number. Default: 1. |
limit | integer | Records per page. Default: 25. Requests above 50 are capped at 50. |
Search Behavior
- Include at least one search filter to receive results.
contact_slugperforms a direct lookup and takes priority over all other filters.- Text filters use partial matching by default. Pass
exact_search=truefor exact text matching. - Date range filters are inclusive. For each date range, the
*_tovalue must be greater than or equal to the matching*_fromvalue. - Results are sorted by
updated_atin 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
Exact email search
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"
}
]