Raw schema
{
"type": "object",
"properties": {
"employee_id": {
"description": "Only lessons taught by this teacher (employee id).",
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^\\d+$"
}
]
},
"student_id": {
"description": "Only lessons with this student.",
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^\\d+$"
}
]
},
"location_id": {
"description": "Only lessons at this location (exact).",
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^\\d+$"
}
]
},
"location_or_parent_location_id": {
"description": "Lessons at this location or any of its sub-locations.",
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^\\d+$"
}
]
},
"service_id": {
"description": "Only lessons of this service.",
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^\\d+$"
}
]
},
"series_id": {
"description": "Only lessons of this repeating series.",
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^\\d+$"
}
]
},
"name": {
"description": "Search by lesson name.",
"type": "string"
},
"status": {
"type": "string",
"enum": [
"Scheduled",
"Attended",
"Cancelled",
"Missed"
]
},
"custom_status": {
"description": "Search by custom status (Custom Statuses add-on).",
"type": "string"
},
"from_date": {
"description": "Lessons starting on exactly this date.",
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"date_from": {
"description": "Lessons starting on or after this date.",
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"date_to": {
"description": "Lessons starting on or before this date.",
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"joinable": {
"description": "true = only lessons marked joinable.",
"type": "boolean"
},
"include_deleted": {
"description": "true = include deleted lessons.",
"type": "boolean"
},
"page": {
"description": "Page number (1-based, default 1).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"per_page": {
"description": "Records per page (default 20, max 50).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 50
},
"direction": {
"description": "Sort by id ascending (default) or descending (newest first).",
"type": "string",
"enum": [
"asc",
"desc"
]
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}