List customers
teachworks_list_customersRead-only
List or search customers — the billed profiles: families (with child students) and independent students. Returns contact details, status and last invoice date. GET /customers.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| zip | No | ||
| city | No | ||
| page | No | Page number (1-based, default 1). | |
| type | No | family or independent. | |
| No | Search by email. | ||
| state | No | ||
| status | No | ||
| country | No | ||
| per_page | No | Records per page (default 20, max 50). | |
| direction | No | Sort by id ascending (default) or descending (newest first). | |
| last_name | No | Search by last name. | |
| first_name | No | Search by first name. | |
| phone_number | No | Search by phone number. |