Sign in
AppointmentEnquiries

List appointment enquiries

Use this endpoint to retrieve a list of AppointmentEnquiry resources associated with a Site.

get/shop/reports/appointment-enquiries

Query parameters

site_idstring uuid

Filter the list of enquiries by site

pageinteger

The page to retrieve results from

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.

sortstring

The field to order results by.

sort_order'asc' | 'desc'

The direction to order results by.

Response

The list of AppointmentEnquiry resources was successfully retrieved.

Example response

{
  "data": [
    {
      "cancellation_reason": "expired",
      "order": {
        "order_ref": "TRY00",
        "full_name": "Jessica Jones"
      }
    }
  ],
  "meta": {
    "from": 1,
    "to": 2,
    "total": 2,
    "current_page": 1,
    "last_page": 2,
    "per_page": 15,
    "path": "http://example.com/api"
  },
  "links": {
    "first": "http://example.com?page=1",
    "next": "https://example.com?page=3",
    "prev": "https://example.com?page=1",
    "last": "https://example.com?page=4"
  }
}

Changes

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