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

Get private lesson requests waiting on someone and the lessons in a range of up to two weeks.

Get private lesson requests waiting on someone and the lessons in a range of up to two weeks. 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_lessons_overview
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
ends_atstring<date-time>required
instructor_idstring

Opaque Soljio resource ID.

min length 1
mineboolean
starts_atstring<date-time>required
Responses
200

Successful read.

dataobjectrequired
Show properties
change_requestsobject[]required
Show properties
Array of object
booking_idstringrequired

Opaque Soljio resource ID.

min length 1
from_starts_atstring<date-time>required
household_namestringrequired
lesson_countnumberrequired
lesson_type_namestringrequired
requested_atstring<date-time>required
timezonestringrequired
to_starts_atstring<date-time>required
instructorsobject[]required
Show properties
Array of object
idstringrequired

Opaque Soljio resource ID.

min length 1
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
requestsobject[]required
Show properties
Array of object
balance_minornumberrequired
booking_idstringrequired

Opaque Soljio resource ID.

min length 1
currencystringrequired
deadlinenumber
first_starts_atstring<date-time>required
guest_countnumberrequired
household_namestringrequired
lesson_countnumberrequired
lesson_type_namestringrequired
statusstringrequired
Show properties
Any of:
string
string
string
string
string
string
student_namesstring[]required
timezonestringrequired
setupobjectrequired
Show properties
has_opening_hoursbooleanrequired
lesson_typesnumberrequired
publishednumberrequired
timezonestringrequired
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_lessons_overview' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "ends_at": "2019-08-24T14:15:22Z",
  "instructor_id": "string",
  "mine": true,
  "starts_at": "2019-08-24T14:15:22Z"
}'
Response
{
  "data": {
    "change_requests": [
      {
        "booking_id": "string",
        "from_starts_at": "2019-08-24T14:15:22Z",
        "household_name": "string",
        "lesson_count": 0,
        "lesson_type_name": "string",
        "requested_at": "2019-08-24T14:15:22Z",
        "timezone": "string",
        "to_starts_at": "2019-08-24T14:15:22Z"
      }
    ],
    "instructors": [
      {
        "id": "string",
        "name": "string"
      }
    ],
    "lessons": [
      {
        "balance_minor": 0,
        "booking_id": "string",
        "booking_status": "invitation",
        "cancel_reason": "string",
        "cash_amount_minor": 0,
        "credits": 0,
        "currency": "string",
        "ends_at": "2019-08-24T14:15:22Z",
        "guest_count": 0,
        "household_name": "string",
        "id": "string",
        "instructor_id": "string",
        "instructor_name": "string",
        "lesson_type_name": "string",
        "location_id": "string",
        "location_name": "string",
        "starts_at": "2019-08-24T14:15:22Z",
        "status": "reserved",
        "students": [
          {
            "id": "string",
            "name": "string"
          }
        ],
        "timezone": "string",
        "total_amount_minor": 0
      }
    ],
    "requests": [
      {
        "balance_minor": 0,
        "booking_id": "string",
        "currency": "string",
        "deadline": 0,
        "first_starts_at": "2019-08-24T14:15:22Z",
        "guest_count": 0,
        "household_name": "string",
        "lesson_count": 0,
        "lesson_type_name": "string",
        "status": "invitation",
        "student_names": [
          "string"
        ],
        "timezone": "string"
      }
    ],
    "setup": {
      "has_opening_hours": true,
      "lesson_types": 0,
      "published": 0
    },
    "timezone": "string"
  },
  "request_id": "266ea41d-adf5-480b-af50-15b940c2b846"
}