Contacts
List contacts
List your workspace contact book — everyone the connected WhatsApp account has messaged.
Offset-paginated via limit + skip. Requires contacts:read.
Request
curl -X GET "https://api.blueticks.co/v1/contacts"{
"success": true,
"data": [
{
"chatId": "string",
"name": "string",
"isBusiness": true
}
],
"limit": 0,
"skip": 0,
"total": 0
}{
"success": false,
"error": {
"code": "string",
"message": "string",
"requestId": "string",
"details": [
{
"path": "string",
"code": "string",
"message": "string"
}
]
}
}Query Parameters
searchToken?string
Search token; when set, only items whose name matches are returned.
Length
length <= 200includeArchive?boolean
Include archived chats (default false → archived excluded).
skip?integer
Number of contacts to skip before the page (default 0).
limit?integer
Page size (default 10, max 200). Pass -1 to return every contact in a single page.
Response
Response Body
application/json
application/json