List customers
Search customers by name, email, phone or address, with their service addresses.
GET https://cotlet.dev/api/v1/housecall-pro/customers
read
Returns customer profiles that match the query, as the customer search on a new job does: name, email, phone numbers and each service address. Mobile numbers are marked, because only a number in the Mobile field can receive texts. Pages hold up to 50 customers; pass next_cursor back as cursor for the next page.
Parameters
| Name | Type | Description |
|---|---|---|
| query string | string | Name, email, phone number or address to search for. |
| tag string | string | Only customers with this tag. |
| limit integer | integer | 1 to 50. Default: 20. |
| cursor string | string | Next page cursor from the previous call. |
Request
curl https://cotlet.dev/api/v1/housecall-pro/customers \
-H "Authorization: Bearer $COTLET_API_KEY"result = client.call("housecall-pro", "list_customers")const result = await cotlet.call('housecall-pro', 'list_customers');cotlet call housecall-pro list_customersExample response
{
"customers": [
{
"customer_id": "cus_4f2a91",
"name": "Dana Whitfield",
"email": "dana@example.com",
"mobile": "+1 555 010 0142",
"addresses": [
{
"address_id": "adr_71c0",
"street": "14 Elm Street",
"city": "Springfield",
"state": "IL",
"zip": "62704"
}
],
"tags": [
"Service Plan"
]
}
],
"next_cursor": null
}