Reservations

List partner reservations

Retrieve paginated list of reservations for the authenticated partner.

get/api/v1/partners/{partner_id}/reservations

Request

  • Base URL: https://app.bodyspec.com
  • URL: https://app.bodyspec.com/api/v1/partners/{partner_id}/reservations
  • Auth: one of:
    • HTTPBasic (a scheme the document does not define)
    • HTTP basic

Path parameters

partner_idstring required

Partner ID

Query parameters

pageinteger

Page number (starts at 1)

page_sizeinteger

Items per page (max 100)

status'scheduled' | 'pending_scan' | 'completed' | 'no_show'

Derived appointment outcome.

BodySpec does not record attendance, so the outcome is inferred from whether published results exist and from what happened at the same location that day.

Filter by appointment outcome: 'scheduled', 'pending_scan' (started but results not published yet, or no evidence the location was operating), 'completed', or 'no_show'. A reservation_no_show webhook is emitted when an appointment becomes 'no_show'

sort_order'newest_first' | 'oldest_first'

Sort order options for appointment lists.

Sort order: 'newest_first' or 'oldest_first'

start_time[eq]string date-time nullable

ISO 8601 datetime: start_time = value

start_time[gt]string date-time nullable

ISO 8601 datetime: start_time > value

start_time[gte]string date-time nullable

ISO 8601 datetime: start_time >= value

start_time[lt]string date-time nullable

ISO 8601 datetime: start_time < value

start_time[lte]string date-time nullable

ISO 8601 datetime: start_time <= value

reserve_time[eq]string date-time nullable

ISO 8601 datetime: reserve_time = value

reserve_time[gt]string date-time nullable

ISO 8601 datetime: reserve_time > value

reserve_time[gte]string date-time nullable

ISO 8601 datetime: reserve_time >= value

reserve_time[lt]string date-time nullable

ISO 8601 datetime: reserve_time < value

reserve_time[lte]string date-time nullable

ISO 8601 datetime: reserve_time <= value

Response

Successful response

Example response

{
  "reservations": [
    {
      "user": {
        "phone": "+14155551234"
      }
    }
  ]
}

Changes

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