API ReferenceTime slots

List reschedule slots

List the time slots an appointment can move to.

The appointment and its synced calendar event do not block slots, slots use the buffer policy captured on the appointment, and the service's booking policy is not enforced. The appointment's current time is omitted for its current provider.

Returns a 404 when the caller cannot reschedule the appointment, and a 422 when the appointment is canceled.

GET
/v1/appointments/{appointment_id}/reschedule_slots

Authorization

authorization
AuthorizationBearer <token>

In: header

Path Parameters

appointment_id*string

Appointment ID

Query Parameters

provider_ids?string

Providers to list slots for (comma-separated). Defaults to the appointment's current provider. To move the appointment to another provider, send that provider's ID as provider_id when rescheduling. Returns a 404 when an ID does not match an active provider on the service, or when the list includes another provider and the caller can only reschedule their own appointments.

from?string

Start of time range (ISO date format). Defaults to today in time_zone when supplied, otherwise today in UTC.

Formatdate
until?string

End of time range (ISO date format). Either until or limit must be provided.

Formatdate
limit?integer

Maximum number of available slots to return. Either limit or until must be provided.

Range1 <= value
time_zone?string

IANA time zone for the slots. Slot times are formatted in this zone (Etc/UTC when omitted). When supplied, from and until are interpreted as calendar dates in this zone; when omitted, they are interpreted in the service's time zone.

Default"Etc/UTC"

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/appointments/appt_123456789012/reschedule_slots?provider_ids=prv_123456789012%2Cprv_234567890123&from=%222025-04-01%22&until=%222025-04-07%22&limit=10&time_zone=America%2FChicago"
{  "data": {    "aggregated_slots": [      {        "count": 1,        "end_at": "2025-03-10T10:00:00Z",        "end_at_ts": 1736464800,        "object": "aggregated_slot",        "start_at": "2025-03-10T09:00:00Z",        "start_at_ts": 1736461200,        "time_zone": "Etc/UTC"      },      {        "count": 1,        "end_at": "2025-03-10T12:00:00Z",        "end_at_ts": 1736468400,        "object": "aggregated_slot",        "start_at": "2025-03-10T11:00:00Z",        "start_at_ts": 1736464800,        "time_zone": "Etc/UTC"      }    ],    "provider_slots": [      {        "open": [          {            "end_at": "2025-03-10T10:00:00Z",            "end_at_ts": 1736464800,            "object": "slot",            "start_at": "2025-03-10T09:00:00Z",            "start_at_ts": 1736461200,            "time_zone": "Etc/UTC"          },          {            "end_at": "2025-03-10T12:00:00Z",            "end_at_ts": 1736468400,            "object": "slot",            "start_at": "2025-03-10T11:00:00Z",            "start_at_ts": 1736464800,            "time_zone": "Etc/UTC"          }        ],        "service_provider": {          "created_at": "2025-02-19T17:36:36Z",          "id": "sp_d025a96ac0c6",          "object": "service_provider",          "provider": {            "created_at": "2017-09-12T12:34:55Z",            "display_name": "John Smith",            "email": "john@example.com",            "first_name": "John",            "id": "prov_d025a96ac0c6",            "last_name": "Smith",            "metadata": {              "external_id": "123"            },            "object": "provider",            "time_zone": "America/New_York",            "updated_at": "2017-09-13T10:11:12Z"          },          "service_id": "srv_d025a96ac0c6",          "updated_at": "2025-02-19T17:36:36Z"        }      }    ]  }}