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

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.

POST/queries/get_private_lesson_setup
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
object
Responses
200

Successful read.

dataobjectrequired
Show properties
availabilityobject[]required
Show properties
Array of object
idstringrequired

Opaque Soljio resource ID.

min length 1
exceptionsobject[]required
Show properties
Array of object
datestringrequired
windowsobject[]required
Show properties
Array of object
end_minutenumberrequired
start_minutenumberrequired
instructor_idstring

Opaque Soljio resource ID.

min length 1
location_idstringrequired

Opaque Soljio resource ID.

min length 1
resource_idstring

Opaque Soljio resource ID.

min length 1
timezonestringrequired
windowsobject[]required
Show properties
Array of object
end_minutenumberrequired
start_minutenumberrequired
weekdaynumberrequired
instructorsobject[]required
Show properties
Array of object
idstringrequired

Opaque Soljio resource ID.

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

Opaque Soljio resource ID.

min length 1
allow_instructor_choicebooleanrequired
allow_pay_laterbooleanrequired
approval_hoursnumberrequired
booking_increment_minutesnumberrequired
buffer_after_minutesnumberrequired
buffer_before_minutesnumberrequired
cancellation_hoursnumberrequired
capacitynumberrequired
descriptionstringrequired
duration_minutesnumberrequired
horizon_daysnumberrequired
instructor_permissionsobjectrequired
Show properties
approvalbooleanrequired
availabilitybooleanrequired
reschedulebooleanrequired
invitation_hoursnumberrequired
locationsobject[]required
Show properties
Array of object
instructor_idsstring[]required
location_idstringrequired

Opaque Soljio resource ID.

min length 1
resource_groupsstring[][]required
max_agenumber
min_agenumber
namestringrequired
notice_hoursnumberrequired
payment_hoursnumberrequired
pricingobjectrequired
Show properties
amount_minornumberrequired
currencystringrequired
group_ratesobject[]required
Show properties
Array of object
amount_minornumberrequired
studentsnumberrequired
modestringrequired
Show properties
Any of:
string
string
string
string
publishedbooleanrequired
reminder_hoursnumberrequired
requires_approvalbooleanrequired
skill_levelsstring[]required
updated_atstring<date-time>required
locationsobject[]required
Show properties
Array of object
idstringrequired

Opaque Soljio resource ID.

min length 1
namestringrequired
timezonestring
online_paymentsbooleanrequired
pack_typesobject[]required
Show properties
Array of object
idstringrequired

Opaque Soljio resource ID.

min length 1
creditsnumberrequired
currencystringrequired
expiry_daysnumber
group_sizesnumber[]required
lesson_type_idsstring[]required
namestringrequired
price_minornumberrequired
publishedbooleanrequired
single_studentbooleanrequired
unitstringrequired
Show properties
Any of:
string
string
string
string
resourcesobject[]required
Show properties
Array of object
idstringrequired

Opaque Soljio resource ID.

min length 1
kindstringrequired
location_idstring

Opaque Soljio resource ID.

min length 1
namestringrequired
skill_levelsstring[]required
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_lesson_setup' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{}'
Response
{
  "data": {
    "availability": [
      {
        "id": "string",
        "exceptions": [
          {
            "date": "string",
            "windows": [
              {
                "end_minute": 0,
                "start_minute": 0
              }
            ]
          }
        ],
        "instructor_id": "string",
        "location_id": "string",
        "resource_id": "string",
        "timezone": "string",
        "windows": [
          {
            "end_minute": 0,
            "start_minute": 0,
            "weekday": 0
          }
        ]
      }
    ],
    "instructors": [
      {
        "id": "string",
        "name": "string"
      }
    ],
    "lesson_types": [
      {
        "id": "string",
        "allow_instructor_choice": true,
        "allow_pay_later": true,
        "approval_hours": 0,
        "booking_increment_minutes": 0,
        "buffer_after_minutes": 0,
        "buffer_before_minutes": 0,
        "cancellation_hours": 0,
        "capacity": 0,
        "description": "string",
        "duration_minutes": 0,
        "horizon_days": 0,
        "instructor_permissions": {
          "approval": true,
          "availability": true,
          "reschedule": true
        },
        "invitation_hours": 0,
        "locations": [
          {
            "instructor_ids": [
              "string"
            ],
            "location_id": "string",
            "resource_groups": [
              [
                "string"
              ]
            ]
          }
        ],
        "max_age": 0,
        "min_age": 0,
        "name": "string",
        "notice_hours": 0,
        "payment_hours": 0,
        "pricing": {
          "amount_minor": 0,
          "currency": "string",
          "group_rates": [
            {
              "amount_minor": 0,
              "students": 0
            }
          ],
          "mode": "booking"
        },
        "published": true,
        "reminder_hours": 0,
        "requires_approval": true,
        "skill_levels": [
          "string"
        ],
        "updated_at": "2019-08-24T14:15:22Z"
      }
    ],
    "locations": [
      {
        "id": "string",
        "name": "string",
        "timezone": "string"
      }
    ],
    "online_payments": true,
    "pack_types": [
      {
        "id": "string",
        "credits": 0,
        "currency": "string",
        "expiry_days": 0,
        "group_sizes": [
          0
        ],
        "lesson_type_ids": [
          "string"
        ],
        "name": "string",
        "price_minor": 0,
        "published": true,
        "single_student": true,
        "unit": "booking"
      }
    ],
    "resources": [
      {
        "id": "string",
        "kind": "string",
        "location_id": "string",
        "name": "string"
      }
    ],
    "skill_levels": [
      "string"
    ],
    "timezone": "string"
  },
  "request_id": "266ea41d-adf5-480b-af50-15b940c2b846"
}