Skip to main content
GET
cURL

Filtering by Status

Use the status query parameter to filter sessions:
  • active — Session is currently in progress (not expired, no appointment created)
  • completed — Session resulted in a booked appointment
  • abandoned — Session expired without creating an appointment

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-Client-Id
string
required

The location id of the practice

Query Parameters

updated_at_start
string<date-time>
required

Start of the date range for filtering sessions by updated_at. ISO 8601 format.

updated_at_end
string<date-time>

End of the date range for filtering sessions by updated_at. If not provided, the current date will be used.

status
enum<string>

Filter sessions by status. 'active' = in progress, 'completed' = resulted in an appointment, 'abandoned' = expired without booking.

Available options:
active,
completed,
abandoned
page
integer
default:0

Page number (0-based)

per_page
integer
default:10

Number of results per page

Response

Booking sessions response

success
boolean
required
data
object
required
message
string