List customers
aryeo_list_customersList your customers (the agents, brokerages and teams who order from you) with contact details and balances. Filter by name, email, email domain, phone or search text. GET /customers.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | Customers with this name. | |
| page | No | Page number, from 1 (default 1). Pass the previous reply's next_page. | |
| sort | No | Comma-separated sort fields; a leading - sorts descending. Default -created_at. | |
| No | Customers with this exact email address. | ||
| phone | No | Customers with this phone number. | |
| search | No | Customers matching this text. | |
| include | No | Comma-separated relations to expand. Example: users. An unknown value makes Aryeo reply with the allowed list. | |
| per_page | No | Results per page, 1-100 (Aryeo default 25). | |
| email_domain | No | Customers whose email is on this domain, e.g. gmail.com. | |
| customer_team_ids | No | Comma-separated customer team ids. |