Search customers
Find customers by name, email or phone.
GET https://cotlet.dev/api/v1/simpro/customers/search
read
Returns matching company and individual customers with ID, name and the sites on record, best match first. Pages through the result. A customer is found only if it exists in your Simpro build. Your Simpro permissions decide which customers appear.
Parameters
| Name | Type | Description |
|---|---|---|
| query string required | string | Name, email address or phone number. |
| page integer | integer | Page number, starting at 1. |
Request
curl "https://cotlet.dev/api/v1/simpro/customers/search?query=query" \
-H "Authorization: Bearer $COTLET_API_KEY"result = client.call("simpro", "search_customers", {"query":"query"})const result = await cotlet.call('simpro', 'search_customers', {"query":"query"});cotlet call simpro search_customers --data '{"query":"query"}'Example response
{
"results": [
{
"customer_id": 3318,
"type": "company",
"name": "Harbour Dental",
"sites": [
{
"site_id": 5107,
"name": "12 Pier Rd"
}
]
}
],
"page": 1,
"has_more": false
}