GET
/
contacts
/
query
cURL
curl --request GET \
  --url https://api.callab.ai/v1/contacts/query \
  --header 'Authorization: Bearer <token>'
{
  "status": "ok",
  "message": "<string>",
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "company_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "firstname": "<string>",
      "lastname": "<string>",
      "phone_number": "<string>",
      "metadata": {},
      "number_country_code": "<string>",
      "last_call_status": "<string>",
      "last_call_at": "2023-11-07T05:31:56Z",
      "last_call_duration": 123,
      "last_call_feedback": "<string>",
      "source_name": "<string>",
      "tag_name": "<string>",
      "category_name": "<string>",
      "notes": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "campaign_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "<string>",
      "workspace_id": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
source_name
string

Filter contacts by their acquisition source name.

​
search
string

Search term for contacts (e.g., matches firstname, lastname, phone_number).

​
last_call_statuses
string

Filter contacts by the status of their most recent call. Comma-separated list if multiple.

​
page
integer
default:0

Page number for pagination.

​
per_page
integer
default:10

Number of items per page for pagination.

​
workspace
string

Workspace slug. If not provided, it will fall back to use the "default" workspace.

​
campaign_id
string

Filter contacts by a specific campaign ID.

​
status
string

Filter by the general status of the contact.

​
start_date
string

Filter contacts created on or after this date (YYYY-MM-DD).

​
end_date
string

Filter contacts created on or before this date (YYYY-MM-DD).

​
sort_column
string
default:created_at

Column to sort contacts by (e.g., 'created_at', 'lastname').

​
order
enum<string>
default:desc

Sort order.

Available options:
asc,
desc
​
filter_columns
string

Comma-separated list of contact fields to apply filters on (e.g., 'tag_name,category_name').

​
filter_values
string

Comma-separated list of values corresponding to filter_columns.

​
filter_operator
string

Comma-separated list of operators (e.g., 'eq,contains') corresponding to filter_columns and filter_values. Or a single operator to apply to all.

Response

200 - application/json

Contact response

The response is of type object.