List bookings
list_bookingsLists bookings by status, date range, customer, or provider so you can review schedules, assignments, and payment status in your store.
Instructions
Bookings of the store: upcoming, unassigned, completed, charge pending or declined.
Lists bookings as the Bookings page shows them, newest schedule dates first within the filter, with the customer, address, assigned providers, total and whether it is charged. Filter by status, date range, a search on the customer, or one customer or provider. Cancelled bookings are not listed. Page with next_cursor.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Page size. Default: 20. | |
| cursor | No | next_cursor from the previous call. | |
| search | No | Customer name, email or phone. | |
| status | No | Which bookings: upcoming (default), today, unassigned, completed, pending (charge pending), declined (charge declined), paused or all. | |
| end_date | No | Up to this date. | |
| start_date | No | From this date. | |
| customer_id | No | Only this customer's bookings. | |
| provider_id | No | Only this provider's bookings. |