List customers
Customers matching a name, email address or phone number.
GET https://cotlet.dev/api/v1/freescout/customers
read
Searches the customers of your FreeScout, one page at a time. A customer can have several email addresses, and all of them are returned. FreeScout keeps one customer table for all mailboxes, so a customer may appear with conversations from several of them.
Parameters
| Name | Type | Description |
|---|---|---|
| query string required | string | Name, email address or phone number. |
| page integer | integer | Page number, starting at 1. Follow it while has_more is true. |
Request
curl "https://cotlet.dev/api/v1/freescout/customers?query=query" \
-H "Authorization: Bearer $COTLET_API_KEY"result = client.call("freescout", "list_customers", {"query":"query"})const result = await cotlet.call('freescout', 'list_customers', {"query":"query"});cotlet call freescout list_customers --data '{"query":"query"}'Example response
{
"customers": [
{
"customer_id": 311,
"name": "Lena Ortiz",
"emails": [
"lena@example.com"
],
"phone": "+1 555 0142"
}
],
"page": 1,
"has_more": false
}