API Documentation
Endpoint Examples
Phone Numbers
Campaigns
Webhooks
Contacts
Query Contacts
Query contacts with filters
POST
/
contact
/
query
curl --request POST \
--url http://sandbox.mintlify.com/contact/query \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"tags": [
"<string>"
],
"categories": [
"<string>"
],
"source_names": [
"<string>"
],
"last_call_statuses": [
"<string>"
]
}'
{
"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>"
}
]
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
application/json
Query filters
The body is of type object
.
Response
200 - application/json
Contact response
The response is of type object
.
Was this page helpful?
curl --request POST \
--url http://sandbox.mintlify.com/contact/query \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"tags": [
"<string>"
],
"categories": [
"<string>"
],
"source_names": [
"<string>"
],
"last_call_statuses": [
"<string>"
]
}'
{
"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>"
}
]
}
Assistant
Responses are generated using AI and may contain mistakes.