Sign in
Appointments

Queue an export of the appointments list

Queues a background job that exports the same Appointment list returned by GET /shop/appointments as a CSV download. Use this when the result set is too large to retrieve synchronously, or when you want the export delivered to the calling user as a downloadable file.

The response returns a QueuedJob resource you can poll via GET /shop/queued-jobs/{queuedJobId}. Once the job has finished, its download_url becomes available and the CSV can be streamed.

All filters supported by the list endpoint (date range, order submitted range, practitioner, room, zone) are accepted here and are applied to the export.

get/shop/appointments/queue

Query parameters

site_idstring required

Filter results by the site they belong to

date_fromstring date

Restrict results to those on or after this date, ISO-8601 YYYY-MM-DD.

date_tostring date

Restrict results to those on or before this date, ISO-8601 YYYY-MM-DD.

order_submitted_at_fromstring date

the order submitted date to fetch appointments from

order_submitted_at_tostring date

the order submitted date to fetch appointments to

practitioner_idstring[]

A comma separated string of practitioner ids to fetch bookings for

room_idstring[]

A comma separated string of room ids to fetch bookings for

zone_idstring[]

A comma separated string of zone ids to fetch bookings for

Response

The job was successfully queued

Example response

{
  "data": {
    "created_at": "2023-11-07T00:00:00+00:00",
    "updated_at": "2023-11-07T01:00:00+00:00"
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.