Skip to content
Soljio Docs
Esc
↑↓navigate↵open⌘Jpreview

Get a private lesson booking with its lessons, family, guests and payments.

Get a private lesson booking with its lessons, family, guests and payments. An organization-scoped read using JSON filter arguments; requires private_lessons.read. Pagination cursors must be reused only with the same organization, operation and filters.

POST/queries/get_private_lesson_booking
Authorization
AuthorizationBearer token (soljio_sk_<secret>) · headerrequired

Organization-scoped service token created by an owner/admin. Scope requirements are in x-required-scopes; these are service-token grants, not OAuth scopes. Revoked, expired, unknown and suspended-organization credentials all return 401.

Request body
requiredapplication/json
booking_idstringrequired

Opaque Soljio resource ID.

min length 1
Responses
200

Successful read.

dataobject | nullrequired
Show properties
Any of:
null
null
object
allow_instructor_choicebooleanrequired
amount_due_minornumberrequired
can_approvebooleanrequired
can_managebooleanrequired
can_reschedulebooleanrequired
cancellation_hoursnumberrequired
change_requestobject
Show properties
changesobject[]required
Show properties
Array of object
appointment_idstringrequired

Opaque Soljio resource ID.

min length 1
from_starts_atstring<date-time>required
timezonestringrequired
to_starts_atstring<date-time>required
requested_atstring<date-time>required
created_atstring<date-time>required
currencystringrequired
deadlinenumber
duration_minutesnumberrequired
householdobjectrequired
Show properties
emailstring
idstringrequired

Opaque Soljio resource ID.

min length 1
namestringrequired
idstringrequired

Opaque Soljio resource ID.

min length 1
instructor_optionsobject[]required
Show properties
Array of object
idstringrequired

Opaque Soljio resource ID.

min length 1
namestringrequired
invitationsobject[]required
Show properties
Array of object
emailstringrequired
idstringrequired

Opaque Soljio resource ID.

min length 1
lesson_countnumberrequired
statusstringrequired
Show properties
Any of:
string
string
string
string
string
string
string
string
student_namestring
lesson_type_idstringrequired

Opaque Soljio resource ID.

min length 1
lesson_type_namestringrequired
lessonsobject[]required
Show properties
Array of object
balance_minornumberrequired
booking_idstringrequired

Opaque Soljio resource ID.

min length 1
booking_statusstringrequired
Show properties
Any of:
string
string
string
string
string
string
string
string
string
string
string
string
cancel_reasonstring
cash_amount_minornumberrequired
creditsnumberrequired
currencystringrequired
ends_atstring<date-time>required
guest_countnumberrequired
household_namestringrequired
idstringrequired

Opaque Soljio resource ID.

min length 1
instructor_idstringrequired

Opaque Soljio resource ID.

min length 1
instructor_namestringrequired
lesson_type_namestringrequired
location_idstringrequired

Opaque Soljio resource ID.

min length 1
location_namestringrequired
starts_atstring<date-time>required
statusstringrequired
Show properties
Any of:
string
string
string
string
string
string
string
string
studentsobject[]required
Show properties
Array of object
idstringrequired

Opaque Soljio resource ID.

min length 1
namestringrequired
timezonestringrequired
total_amount_minornumberrequired
attendanceobject[]required
Show properties
Array of object
notestringrequired
participant_idstringrequired

Opaque Soljio resource ID.

min length 1
statusstringrequired
Show properties
Any of:
string
string
string
string
string
string
can_record_attendancebooleanrequired
location_idstringrequired

Opaque Soljio resource ID.

min length 1
paid_minornumberrequired
pay_laterbooleanrequired
refund_due_minornumberrequired
requires_approvalbooleanrequired
statusstringrequired
Show properties
Any of:
string
string
string
string
string
string
string
string
string
string
string
string
transactionsobject[]required
Show properties
Array of object
amount_minornumberrequired
created_atstring<date-time>required
idstringrequired

Opaque Soljio resource ID.

min length 1
kindstringrequired
Show properties
Any of:
string
string
string
string
methodstringrequired
request_idstring<uuid>required
400

invalid_request

errorobjectrequired
Show properties
codestringrequired
Allowed:invalid_request
messagestringrequired
request_idstring<uuid>required
401

unauthorized

errorobjectrequired
Show properties
codestringrequired
Allowed:unauthorized
messagestringrequired
request_idstring<uuid>required
403

forbidden

errorobjectrequired
Show properties
codestringrequired
Allowed:forbidden
messagestringrequired
request_idstring<uuid>required
404

not_found

errorobjectrequired
Show properties
codestringrequired
Allowed:not_found
messagestringrequired
request_idstring<uuid>required
405

method_not_allowed

errorobjectrequired
Show properties
codestringrequired
Allowed:method_not_allowed
messagestringrequired
request_idstring<uuid>required
409

conflict, idempotency_conflict

errorobjectrequired
Show properties
codestringrequired
Allowed:conflictidempotency_conflict
messagestringrequired
request_idstring<uuid>required
413

payload_too_large

errorobjectrequired
Show properties
codestringrequired
Allowed:payload_too_large
messagestringrequired
request_idstring<uuid>required
415

unsupported_media_type

errorobjectrequired
Show properties
codestringrequired
Allowed:unsupported_media_type
messagestringrequired
request_idstring<uuid>required
429

rate_limited

errorobjectrequired
Show properties
codestringrequired
Allowed:rate_limited
messagestringrequired
request_idstring<uuid>required
500

internal_error

errorobjectrequired
Show properties
codestringrequired
Allowed:internal_error
messagestringrequired
request_idstring<uuid>required
Try it
Server
Authorization
Bodyapplication/json
Request
curl -X POST 'https://api.soljio.com/v0/queries/get_private_lesson_booking' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "booking_id": "string"
}'
Response
{
  "data": {},
  "request_id": "266ea41d-adf5-480b-af50-15b940c2b846"
}