Chats
List chat participants
For group chats, returns the participant list (paginated).
For DMs, returns the single counterparty. Requires chats:read.
Request
curl -X GET "https://api.blueticks.co/v1/chats//participants"{
"success": true,
"data": [
{
"chatId": "string",
"name": "string",
"isAdmin": true,
"isSuperAdmin": true
}
],
"limit": 0,
"skip": 0,
"total": 0,
"nextCursor": "string"
}{
"success": false,
"error": {
"code": "string",
"message": "string",
"request_id": "string",
"requestId": "string",
"details": [
{
"path": "string",
"code": "string",
"message": "string"
}
],
"upgrade": {
"url": "string",
"text": "string",
"reset_time": "string",
"seconds_remaining": 0,
"plan": {}
}
}
}Path Parameters
chatId*string
Query Parameters
searchToken?string
Search token; when set, only participants whose resolved name or phone/JID matches (case-insensitive substring) are returned, and total reflects the matched count.
Length
length <= 200engine?string
Force the read to a specific engine TYPE: "gateway" (server-side pod, e.g. Baileys) or "regular" (browser extension). Overrides the default dual-engine read preference. 409 ENGINE_NOT_ONLINE if none of that type is online.
Value in
"gateway" | "regular"engineId?string
Exact engine clientId to target (from the engine status id); wins over engine. 409 ENGINE_NOT_ONLINE if not online.
Length
1 <= length <= 200skip?integer
Number of participants to skip before the page (default 0).
Default
0Range
0 <= valuelimit?integer
Max participants to return.
Default
100Range
1 <= value <= 500Response
Response Body
application/json
application/json