Get list of schedules

GET /schedules

Query parameters

  • trainer_id integer
  • billing_period_id integer
  • course_id integer
  • place_id integer
  • room_id integer
  • page integer
  • page_size integer

    Default value is 20.

  • day integer

    Day of the schedule (Monday through Sunday)

  • ids string

    List of schedule ID's concatenated by |

  • name string
  • registration_type string

    Values are full2, open, or single.

  • Labels string

    List of label ID's concatenated by |

  • status string
  • sort_by string

    Values are created_desc, created_asc, date_asc, date_desc, registrations_asc, registrations_desc, name_asc, or place_asc.

  • start string(date)
  • end string(date)
  • online_registration boolean
  • lead_only boolean
  • in_progress boolean
  • ended boolean
  • not_started boolean
  • billing_period_active boolean
  • under_billable boolean
  • over_billable boolean
  • load_labels boolean
  • load_trainers boolean

Responses

  • 200 application/json

    Course detail

    Hide response attributes Show response attributes object
    • total integer
    • page integer
    • page_size integer
    • settings object
    • data array[object]
      Hide data attributes Show data attributes object
      • company_id string

        ID of company that record belongs to

      • id integer

        Resource ID

      • course_id integer
      • time integer

        Time in minutes from midnights when schedule starts

      • duration integer
      • place_id integer
      • room_id integer
      • trainer_id integer

        Trainer_ID is a synonym to User_ID

      • registrations_cap integer
      • capacity integer
      • extra_capacity integer
      • total_events integer
      • __calc__total_avg_nps_score integer
      • __calc__total_requests integer

        total feedback requests sent

      • __calc__registered integer

        Total registrations with status: registered

      • __calc__waitlist integer

        Total registrations with status: waitlist

      • __calc__late

        Total registrations with status: late

      • trainer_rate_type_id integer
      • __calc__remaining_events integer
      • type string
      • name string
      • start string(date)
      • end string(date)
      • extra_capacity_usage string
      • status string
      • note string
      • notify_trainer_on_cancellation string
      • public boolean
      • online_registration boolean
      • price integer(float)
      • registration_fee integer(float)
GET /schedules
curl \
 --request GET 'https://api.zooza.app/v1/schedules'
Response examples (200)
{
  "total": 42,
  "page": 42,
  "page_size": 42,
  "settings": {},
  "data": [
    {
      "company_id": "string",
      "id": 42,
      "course_id": 42,
      "time": 42,
      "duration": 42,
      "place_id": 42,
      "room_id": 42,
      "trainer_id": 42,
      "registrations_cap": 42,
      "capacity": 42,
      "extra_capacity": 42,
      "total_events": 42,
      "__calc__total_avg_nps_score": 42,
      "__calc__total_requests": 42,
      "__calc__registered": 42,
      "__calc__waitlist": 42,
      "trainer_rate_type_id": 42,
      "__calc__remaining_events": 42,
      "type": "string",
      "name": "string",
      "start": "2025-05-04",
      "end": "2025-05-04",
      "extra_capacity_usage": "string",
      "status": "string",
      "note": "string",
      "notify_trainer_on_cancellation": "string",
      "public": true,
      "online_registration": true,
      "price": 42,
      "registration_fee": 42
    }
  ]
}