List clients
List the clients in the CRM section with their tags, status and assigned agent.
GET https://cotlet.dev/api/v1/jivochat/clients
read
list_clients returns one page of the Clients list in CRM: name, email, phone, tags, status, the assigned agent and the number of conversations. The tag filter matches the tags your team already uses. The cursor continues the same search.
Parameters
| Name | Type | Description |
|---|---|---|
| query string | string | Search text: name, email or phone. |
| tag string | string | Only clients with this tag. |
| cursor string | string | Next page cursor from the previous call. |
Request
curl https://cotlet.dev/api/v1/jivochat/clients \
-H "Authorization: Bearer $COTLET_API_KEY"result = client.call("jivochat", "list_clients")const result = await cotlet.call('jivochat', 'list_clients');cotlet call jivochat list_clientsExample response
{
"clients": [
{
"client_id": "cl_3a91",
"name": "Dana Whitfield",
"email": "dana@example.com",
"phone": "+1 555 0100",
"tags": [
"wholesale"
],
"status": "New",
"owner": "sam@example.com",
"conversations": 3
},
{
"client_id": "cl_7b20",
"name": "D. Whitfield",
"email": "dana@example.com",
"phone": null,
"tags": [],
"status": "New",
"owner": null,
"conversations": 1
}
],
"next_cursor": null
}