Get private lesson types, availability, pack types and the locations, instructors and resources they use.
Get private lesson types, availability, pack types and the locations, instructors and resources they use. 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.
/queries/get_private_lesson_setupAuthorizationBearer token (soljio_sk_<secret>) · headerrequiredOrganization-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.
application/jsonobjectSuccessful read.
dataobjectrequiredShow propertiesHide properties
availabilityobject[]requiredShow propertiesHide properties
objectidstringrequiredOpaque Soljio resource ID.
exceptionsobject[]requiredShow propertiesHide properties
objectdatestringrequiredwindowsobject[]requiredShow propertiesHide properties
objectend_minutenumberrequiredstart_minutenumberrequiredinstructor_idstringOpaque Soljio resource ID.
location_idstringrequiredOpaque Soljio resource ID.
resource_idstringOpaque Soljio resource ID.
timezonestringrequiredwindowsobject[]requiredShow propertiesHide properties
objectend_minutenumberrequiredstart_minutenumberrequiredweekdaynumberrequiredinstructorsobject[]requiredShow propertiesHide properties
objectidstringrequiredOpaque Soljio resource ID.
namestringrequiredlesson_typesobject[]requiredShow propertiesHide properties
objectidstringrequiredOpaque Soljio resource ID.
allow_instructor_choicebooleanrequiredallow_pay_laterbooleanrequiredapproval_hoursnumberrequiredbooking_increment_minutesnumberrequiredbuffer_after_minutesnumberrequiredbuffer_before_minutesnumberrequiredcancellation_hoursnumberrequiredcapacitynumberrequireddescriptionstringrequiredduration_minutesnumberrequiredhorizon_daysnumberrequiredinstructor_permissionsobjectrequiredShow propertiesHide properties
approvalbooleanrequiredavailabilitybooleanrequiredreschedulebooleanrequiredinvitation_hoursnumberrequiredlocationsobject[]requiredShow propertiesHide properties
objectinstructor_idsstring[]requiredlocation_idstringrequiredOpaque Soljio resource ID.
resource_groupsstring[][]requiredmax_agenumbermin_agenumbernamestringrequirednotice_hoursnumberrequiredpayment_hoursnumberrequiredpricingobjectrequiredShow propertiesHide properties
amount_minornumberrequiredcurrencystringrequiredgroup_ratesobject[]requiredShow propertiesHide properties
objectamount_minornumberrequiredstudentsnumberrequiredmodestringrequiredShow propertiesHide properties
stringstringpublishedbooleanrequiredreminder_hoursnumberrequiredrequires_approvalbooleanrequiredskill_levelsstring[]requiredupdated_atstring<date-time>requiredlocationsobject[]requiredShow propertiesHide properties
objectidstringrequiredOpaque Soljio resource ID.
namestringrequiredtimezonestringonline_paymentsbooleanrequiredpack_typesobject[]requiredShow propertiesHide properties
objectidstringrequiredOpaque Soljio resource ID.
creditsnumberrequiredcurrencystringrequiredexpiry_daysnumbergroup_sizesnumber[]requiredlesson_type_idsstring[]requirednamestringrequiredprice_minornumberrequiredpublishedbooleanrequiredsingle_studentbooleanrequiredunitstringrequiredShow propertiesHide properties
stringstringresourcesobject[]requiredShow propertiesHide properties
objectidstringrequiredOpaque Soljio resource ID.
kindstringrequiredlocation_idstringOpaque Soljio resource ID.
namestringrequiredskill_levelsstring[]requiredtimezonestringrequiredrequest_idstring<uuid>requiredinvalid_request
errorobjectrequiredShow propertiesHide properties
codestringrequiredinvalid_requestmessagestringrequiredrequest_idstring<uuid>requiredunauthorized
errorobjectrequiredShow propertiesHide properties
codestringrequiredunauthorizedmessagestringrequiredrequest_idstring<uuid>requiredforbidden
errorobjectrequiredShow propertiesHide properties
codestringrequiredforbiddenmessagestringrequiredrequest_idstring<uuid>requirednot_found
errorobjectrequiredShow propertiesHide properties
codestringrequirednot_foundmessagestringrequiredrequest_idstring<uuid>requiredmethod_not_allowed
errorobjectrequiredShow propertiesHide properties
codestringrequiredmethod_not_allowedmessagestringrequiredrequest_idstring<uuid>requiredconflict, idempotency_conflict
errorobjectrequiredShow propertiesHide properties
codestringrequiredconflictidempotency_conflictmessagestringrequiredrequest_idstring<uuid>requiredpayload_too_large
errorobjectrequiredShow propertiesHide properties
codestringrequiredpayload_too_largemessagestringrequiredrequest_idstring<uuid>requiredunsupported_media_type
errorobjectrequiredShow propertiesHide properties
codestringrequiredunsupported_media_typemessagestringrequiredrequest_idstring<uuid>requiredrate_limited
errorobjectrequiredShow propertiesHide properties
codestringrequiredrate_limitedmessagestringrequiredrequest_idstring<uuid>requiredinternal_error
errorobjectrequiredShow propertiesHide properties
codestringrequiredinternal_errormessagestringrequiredrequest_idstring<uuid>required