POST list_customers
Customers and prospects with address, email, phone and balance.
read
Lists customers, prospects or both. Search matches name, address, email and phone. Balance is the amount the customer still owes on open invoices. Pass next_cursor back as cursor for the next page.
POST /api/v1/yardbook/list_customers
Input
| Parameter | Type | Description |
|---|---|---|
| type | enum | customer, prospect or all. Default: customer. |
| search | string | Match on name, address, email or phone. |
| limit | integer | 1 to 200. Default: 50. |
| cursor | string | Next page cursor from the previous call. |
Example response
{
"customers": [
{
"customer_id": "284117",
"name": "Maria Lopez",
"type": "customer",
"address": "18 Elm Street",
"email": "maria@example.com",
"phone": "555-0142",
"balance": "0.00"
},
{
"customer_id": "284230",
"name": "Parker Property",
"type": "customer",
"address": "7 Ridge Road",
"email": "office@parker.example.com",
"phone": "555-0177",
"balance": "240.00"
}
],
"next_cursor": null
}