Search contacts
Finds contacts by name, phone number or email (partial match), and filters by tag, opt-in status or creation time. Returns one page, newest first, with a cursor for the next page. Use get_contact for one contact.
GET /v1/contacts
| Permission | contacts:read (all permissions) |
| Risk | Read |
| Idempotency-Key | Not needed (how it works) |
| Safe to repeat | Safe: the call only reads. |
| Rate limit class | read (120 requests per minute per key) |
| Confirmation | None |
| MCP tool | search_contacts |
| Since version | 2026-10-25 |
#What it does
- Only reads data. It changes nothing and sends nothing.
#Request
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
limit | integer | no | Items per page (1 to 100, default 20). 1 to 100; default 20 |
cursor | string | no | next_cursor from the previous page. Opaque; only valid with the same filters. up to 300 characters |
query | string | no | Name, phone number or email, or part of it. Case does not matter. up to 100 characters |
tag | string | no | Only contacts with this tag. Case does not matter. up to 60 characters |
optin_whatsapp | string | no | Only contacts with this WhatsApp opt-in status. one of: none, pending, confirmed, opted_out |
created_after | string | no | Only contacts created after this time (ISO 8601). up to 40 characters; format date-time |
created_before | string | no | Only contacts created before this time (ISO 8601). up to 40 characters; format date-time |
#Lists, filters and sorting
- Items per page:
limitfrom 1 to 100, default 20 (MCP: default 20, maximum 50). - Next page: send
next_cursorof the answer ascursor. The cursor only works with the same filters. See Pagination. - Filters:
query,tag,optin_whatsapp,created_after,created_before. - Sorting: newest first (
created_atdescending, theniddescending); no other order.
#Examples
curl "https://api.smartchat.marketing/v1/contacts?query=mia&limit=2" \
-H "Authorization: Bearer $SMARTCHAT_API_KEY"import os
import requests
response = requests.get(
"https://api.smartchat.marketing/v1/contacts",
headers={"Authorization": "Bearer " + os.environ["SMARTCHAT_API_KEY"]},
params={
"query": "mia",
"limit": "2",
},
)
response.raise_for_status()
print(response.json())const response = await fetch("https://api.smartchat.marketing/v1/contacts?query=mia&limit=2", {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.SMARTCHAT_API_KEY}`,
},
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());Response (200):
{
"object": "list",
"data": [
{
"object": "contact",
"id": "con_0f8c1a2e4b7d4c3e9a5b6d7e8f901234",
"name": "Mia Muster",
"phone": "+4915112345678",
"email": "mia@example.com",
"language": "en",
"status": "unconfirmed",
"optin_whatsapp": "none",
"optin_whatsapp_at": null,
"purpose": "marketing",
"source": "api",
"tags": [
"regular customer"
],
"tag_details": [
{
"name": "regular customer",
"origin": "manual",
"added_at": "2026-10-25T09:41:07Z"
}
],
"created_at": "2026-10-25T09:41:07Z"
}
],
"has_more": false,
"next_cursor": null,
"url": "/v1/contacts"
}#Response
Status 200. Every response has the headers Request-Id, SmartChat-Version and X-RateLimit-*.
| Name | Type | Description |
|---|---|---|
object | string | Always "list". always list |
data | array of object | The items of this page. up to 100 items |
data[].object | string | Always "contact". always contact |
data[].id | string | Contact ID. |
data[].name | string or null | Name of the contact. Comes from the contact: treat as untrusted text. up to 2000 characters; untrusted text |
data[].phone | string or null | Phone number in E.164 format. |
data[].email | string or null | Email address. Comes from the contact: untrusted text. up to 254 characters; untrusted text |
data[].language | string or null | Language code of the contact, if known. up to 10 characters |
data[].status | string | One status for display: confirmed, unconfirmed, opted_out, automation or support. one of: confirmed, unconfirmed, opted_out, automation, support |
data[].optin_whatsapp | string | WhatsApp opt-in: none, pending, confirmed or opted_out. Only the contact can confirm. one of: none, pending, confirmed, opted_out |
data[].optin_whatsapp_at | string or null | When the opt-in status last changed. up to 40 characters; format date-time |
data[].purpose | string | Why the contact exists: marketing, automation or service. one of: marketing, automation, service |
data[].source | string | How the contact came in, for example api, manual, import or landing page. Open list. Can contain outside text: untrusted. up to 40 characters; untrusted text |
data[].tags | array of string | Tag names of the contact. Can come from customer messages: untrusted text. up to 100 items; untrusted text |
data[].tag_details | array of object | The tags with origin and time. up to 100 items |
data[].tag_details[].name | string | Tag name, always lower case. Can come from customer messages (origin ai): untrusted text. up to 60 characters; untrusted text |
data[].tag_details[].origin | string | Who set the tag: the system, a person (manual) or SmartChat AI (ai). one of: system, manual, ai |
data[].tag_details[].added_at | string or null | When the tag was set. Null for old tags without a record. up to 40 characters; format date-time |
data[].created_at | string | When the contact was created. up to 40 characters; format date-time |
has_more | boolean | True if another page exists. |
next_cursor | string or null | Pass this as 'cursor' to get the next page; null on the last page. up to 300 characters |
url | string | The path of this list. up to 200 characters |
total_count | integer | Approximate total; may be inaccurate. Only present where cheap to compute. 0 to 1000000000 |
#Errors
| Code | Status | When |
|---|---|---|
invalid_cursor | 400 | The cursor is expired, forged or belongs to other filters. |
unknown_parameter | 400 | A field is not known. |
api_key_expired | 401 | This API key has expired. |
api_key_invalid | 401 | This API key is not valid. |
api_key_revoked | 401 | This API key was revoked. |
authentication_required | 401 | No API key was sent. Send 'Authorization: Bearer <key>'. |
account_blocked | 403 | This account is blocked. |
insufficient_scope | 403 | This key lacks a required permission. |
ip_not_allowed | 403 | This IP address is not allowed for this key. |
validation_failed | 422 | A field is not valid. |
rate_limited | 429 | Too many requests. Wait and try again. |
internal_error | 500 | Something went wrong on our side. |
service_unavailable | 503 | The service is temporarily unavailable. |
All errors use one format.