Groups
List groups
List the groups the connected WhatsApp engine sees.
Supports offset pagination (limit+skip) and an optional case-insensitive substring search on the group name via searchToken.
Request
curl -X GET "https://api.blueticks.co/v1/groups"{
"success": true,
"data": [
{
"id": "string",
"name": "string",
"description": "string",
"owner": "string",
"createdAt": "2019-08-24T14:15:22Z",
"lastMessageAt": "2019-08-24T14:15:22Z",
"participantCount": 0,
"restrict": 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
1 <= length <= 128includeArchive?boolean
Include archived groups (default false → archived excluded).
skip?integer
Number of items to skip before the page (default 0).
Default
0Range
0 <= valuelimit?integer
Page size (1-200, default 50).
Default
50Range
1 <= value <= 200Response
Response Body
application/json
application/json