List appointments
aryeo_list_appointmentsList appointments (shoots/visits), by default the SCHEDULED ones, newest start first. Filter by upcoming/past, status, a start-time window or the assigned users. Use include=order,order.address,users to see where and who. GET /appointments.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| 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 -start_at. | |
| tense | No | Only upcoming or only past appointments. | |
| include | No | Comma-separated relations to expand. Examples: owner, items, users, order, order.address, order.customer, order.customerGroup, order.listing, order.items, items.product_variant. An unknown value makes Aryeo reply with the allowed list. | |
| per_page | No | Results per page, 1-100 (Aryeo default 25). | |
| statuses | No | Appointment statuses to return (Aryeo default: SCHEDULED). | |
| user_ids | No | Only appointments of these user ids (user ids = company_user.id from aryeo_list_team_members, not the team member id). | |
| start_after | No | Only appointments starting at or after this moment. ISO 8601 date-time with a timezone, e.g. 2026-10-01T13:00:00Z. | |
| start_before | No | Only appointments starting at or before this moment. ISO 8601 date-time with a timezone, e.g. 2026-10-01T13:00:00Z. |