/v1/classes/list

This endpoint retrieves a list of classes based on the provided query parameters.

Request

Parameters:

id_region (number): The ID of the region for which classes are being retrieved.

k_business (number): The ID of the business for which classes are being retrieved.

k_location (number): The ID of the location for which classes are being retrieved.

Response

Status: 200

Content-Type: application/json

The response is in JSON format and has the following schema:

{
  "type": "object",
  "properties": {
    "a_class": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "is_active": { "type": "string" },
          "is_block": { "type": "string" },
          "is_event": { "type": "string" },
          "k_class": { "type": "string" },
          "k_class_period": { "type": "string" },
          "k_business_cms": { "type": "string" },
          "text_title": { "type": "string" },
          "text_description": { "type": "string" },
          "k_enrollment_block": { "type": ["null", "number"] },
          "url_image": { "type": "string" },
          "a_class_tab": {
            "type": ["null", "array"]
          }
        }
      }
    },
    "status": { "type": "string" },
    "s_version": { "type": "string" }
  }
}

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Request#

Response#

Request

Request samples

Responses

Request

Response