Search clients
Searches the Clients tab by name and returns matching client records.
GET https://cotlet.dev/api/v1/planity/clients
read
Returns the id, name, email and phone of each match, enough to pick the right client before get_client or create_appointment. Client records are personal data: the result goes to your agent, so keep the query narrow. The tool never lists the whole client file.
Parameters
| Name | Type | Description |
|---|---|---|
| query string required | string | Part of the client's name, as typed in the search bar of the Clients tab. |
| include_deleted boolean | boolean | Also search records deleted with Supprimer le client (Afficher les clients supprimés). Default false. |
Request
curl "https://cotlet.dev/api/v1/planity/clients?query=query" \
-H "Authorization: Bearer $COTLET_API_KEY"result = client.call("planity", "list_clients", {"query":"query"})const result = await cotlet.call('planity', 'list_clients', {"query":"query"});cotlet call planity list_clients --data '{"query":"query"}'Example response
{
"query": "martin",
"clients": [
{
"client_id": "c_1042",
"name": "Léa Martin",
"email": "client@example.com",
"phone": "+33 6 00 00 00 00"
},
{
"client_id": "c_1190",
"name": "Hugo Martin",
"email": "client2@example.com",
"phone": "+33 6 00 00 00 01"
}
]
}