Sign in
Reports

List appointment enquiries

Use this endpoint to retrieve a list of Sessions.

get/shop/reports/sessions

Query parameters

site_idstring uuid required

Filter the list of sessions by site.

pageinteger

The page to retrieve results from

idstring[]

Include only sessions with this ID.

datestring date
Example:2023-05-05

Include sessions on this date.

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.

start_time_fromstring date-time

Include sessions starting on or after this date.

start_time_tostring date-time

Include sessions starting before this date.

session_type_idstring mongo-id

Include sessions of this type.

recurrence_group_idstring mongo-id

Include sessions with this recurrence group ("session time").

room_idstring mongo-id

Include sessions taking place in this room.

practitioner_idstring mongo-id

Include sessions carried out by this practitioner.

zone_idstring mongo-id

Include sessions taking place in this zone.

include_cancelledboolean

Include cancelled sessions.

cancelledboolean

Only return cancelled sessions.

include_bookingsboolean

Include bookings in the response.

Response

The list of Session resources was successfully retrieved.

Example response

{
  "data": [
    {
      "practitioner": {
        "id": "5dcb47800000000000000000",
        "name": "Jane Doe"
      },
      "room": {
        "id": "5dcb47800000000000000000"
      },
      "currency": "GBP"
    }
  ],
  "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.