Search Contacts
Search for contacts in the system
GET
/api/v1/contacts/search
Path Parameters
search_term
String
Term to search by in the contacts
search_by
String
Field to search by, defaults to all. Allowed fields: email, company, first_name, last_name, user_id
current_page
Number
Current page of the request, allows for pagination
query_amount
Number
Amount of request to get, defaults 20, max is 100
Request
"/api/v1/contacts/search?search_term=ExampleInc&search_by=company&query_amount=5"
Response:
contacts
Array
Contains the contacts that are returned in the search
total_contacts
Number
Total number of contacts matching the query
page
Number
Current page number (0-indexed)
per_page
String
Number of contacts returned per page
Response
{
"contacts": [
{
"email": "john.doe@example.com",
"phone": "",
"company": "ExampleInc",
"created_at": "2025-05-20T14:27:30.180292+00:00",
"id": "123456789012",
"user_id": "23456789012012",
"owner": "Jane",
"last_activity": null,
"last_name": "doe",
"job_title": "",
"notes": null,
"first_name": "john"
}
],
"total_contacts": 1,
"page": 0,
"per_page": 5
}