List clients
Search clients by name.
GET https://cotlet.dev/api/v1/aroflo/clients
read
Returns clients with client_id, name and their locations. Use the client_id in create_task. A search with no match returns an empty list and no error. Cotlet has no tool that creates a client, because AroFlo asks for an extra permission for that.
Parameters
| Name | Type | Description |
|---|---|---|
| search string | string | Part of the client name. |
| cursor string | string | Next page cursor from the previous call. |
Request
curl https://cotlet.dev/api/v1/aroflo/clients \
-H "Authorization: Bearer $COTLET_API_KEY" result = client.call("aroflo", "list_clients") const result = await cotlet.call('aroflo', 'list_clients'); cotlet call aroflo list_clients Example response
{
"clients": [
{
"client_id": "client_311",
"name": "Harbour Café",
"locations": [
"12 Wharf Road"
]
}
],
"next_cursor": null
}