Get List Events

GET /events

Query parameters

filter boolean Required
schedule_id string
billing_period_id integer
bp string

List of Billing Period IDs delimited by pipe |
place_id integer
room_id integer
pid integer

Place and Room ID's combined delimited by underscore
page integer
page_size integer

Default value is 20.
from string(date)
to string(date)
trainer_id integer
course_id integer
past boolean
upcoming_events boolean
schedule_active boolean
sort_by string

Values are created_desc, created_asc, upcoming_asc, date_asc, date_desc, event_no_asc, or event_no_desc.

Responses

200 application/json

Event 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
  
  id integer
  
  company_id string
  
  ID of company that record belongs to
  
  course_id integer
  
  schedule_id integer
  
  trainer_id integer
  
  Trainer_ID is a synonym to User_ID
  
  place_id integer
  
  room_id integer
  
  name string
  
  is_custom_replacement_event boolean
  
  summary string
  
  summary_public string
  
  summary_public_locked boolean
  
  summary_public_filled_by integer
  
  summary_public_unlocked_by integer
  
  summary_public_filled_at string(date-time)
  
  status string
  
  Values are scheduled or unplanned.
  
  date string(date-time)
  
  attendance integer
  
  created string(date-time)
  
  updated string(date-time)
  
  trainer_rate_type_id integer
  
  trainer_payout_percentage integer
  
  __calc__attendance__going integer
  
  __calc__attendance__canceled integer
  
  __calc__attendance__waitlist integer
  
  __calc__attendance__canceled_late integer
  
  __calc__attendance__noshow integer
  
  __calc__attendance__ignore integer
  
  __calc__attendance__deleted integer
  
  __calc__attendance__hold integer
  
  duration integer
  
  __calc__event_trainer string
  
  billable boolean

GET /events

curl \
 -X GET https://api.zooza.app/v1/events?filter=true

Response examples (200)

{
  "total": 42,
  "page": 42,
  "page_size": 42,
  "settings": {},
  "data": [
    {
      "id": 42,
      "company_id": "string",
      "course_id": 42,
      "schedule_id": 42,
      "trainer_id": 42,
      "place_id": 42,
      "room_id": 42,
      "name": "string",
      "is_custom_replacement_event": true,
      "summary": "string",
      "summary_public": "string",
      "summary_public_locked": true,
      "summary_public_filled_by": 42,
      "summary_public_unlocked_by": 42,
      "summary_public_filled_at": "2024-05-04T09:42:00+00:00",
      "status": "scheduled",
      "date": "2024-05-04T09:42:00+00:00",
      "attendance": 42,
      "created": "2024-05-04T09:42:00+00:00",
      "updated": "2024-05-04T09:42:00+00:00",
      "trainer_rate_type_id": 42,
      "trainer_payout_percentage": 42,
      "__calc__attendance__going": 42,
      "__calc__attendance__canceled": 42,
      "__calc__attendance__waitlist": 42,
      "__calc__attendance__canceled_late": 42,
      "__calc__attendance__noshow": 42,
      "__calc__attendance__ignore": 42,
      "__calc__attendance__deleted": 42,
      "__calc__attendance__hold": 42,
      "duration": 42,
      "__calc__event_trainer": "string",
      "billable": true
    }
  ]
}