AppointmentEnquiries
Queue an export of the appointment enquiries list
This endpoint queues an export of the appointment enquiries list.
get/shop/reports/appointment-enquiries/queue
Query parameters
site_idstring uuid
Filter the list of enquiries by site
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.
status'received' | 'confirmed' | 'cancelled'
Show enquiries of this status.
can_confirmstring boolean
Filter the list of enquiries by whether they are currently able to be confirmed.
received_fromstring date
Example:2023-05-05
Include enquiries where the date the enquiry was received is on or after this date.
received_tostring date
Example:2023-05-05
Include enquiries where the date the enquiry was received is on or before this date.
appointment_type_idstring object-id
Show enquiries for this appointment type.
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.