Get a family's students and usable lesson packs for booking on their behalf.
Get a family’s students and usable lesson packs for booking on their behalf. 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_householdAuthorizationBearer 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/jsonhousehold_idstringrequiredOpaque Soljio resource ID.
nownumberrequiredSuccessful read.
dataobjectrequiredShow propertiesHide properties
idstringrequiredOpaque Soljio resource ID.
namestringrequiredpacksobject[]requiredShow propertiesHide properties
objectavailablenumberrequiredexpires_atstring<date-time>idstringrequiredOpaque Soljio resource ID.
namestringrequiredstudentsobject[]requiredShow propertiesHide properties
objectdate_of_birthstringidstringrequiredOpaque Soljio resource ID.
levelstringnamestringrequiredrequest_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