List customers
goteamup_list_customersSearch and list the business's customers (members and leads). Filter by free text (email and name), CRM status, active memberships, age or family. Deferred fields such as field_values, credit_balance or sms_account can be added with expand. TeamUp: GET /customers.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ids | No | Only these customer ids. | |
| page | No | Page number, starting at 1. | |
| query | No | Free-text match against email and name. | |
| expand | No | Comma-separated related fields to expand into full objects (dot-nested, max depth 4), e.g. customer,event.instructors. | |
| family | No | Only customers in this family id. | |
| fields | No | Comma-separated fields to return (dot notation for nested), e.g. id,name,starts_at. | |
| status | No | CRM status slugs, as shown in a customer's `status` field; pass 'null' for customers without a status. | |
| age_gte | No | Minimum age in years. | |
| age_lte | No | Maximum age in years. | |
| deleted | No | Filter by deleted (true) or not deleted (false). | |
| page_size | No | Results per page, 1-100 (default 100). | |
| autocomplete | No | Prefix match from the start of email and name fields. | |
| active_memberships | No | Only customers holding one of these membership (plan) ids. |