Query parameters

• name string

  Requires access right: PUBLIC, LOGGED_IN, SCOPE

• token string

  Requires access right: PUBLIC, LOGGED_IN, SCOPE

• baseLocation string

  Requires access right: PUBLIC, LOGGED_IN, SCOPE

• baseBookable string

  Requires access right: PUBLIC, LOGGED_IN, SCOPE

• secondaryBaseBookable string

  Requires access right: PUBLIC, LOGGED_IN, SCOPE

• eventType string

  Requires access right: PUBLIC, LOGGED_IN, SCOPE

• ageGroup string

  Requires access right: PUBLIC, LOGGED_IN, SCOPE

• processedMinAge string

  Requires access right: PUBLIC, LOGGED_IN, SCOPE

• processedMaxAge string

  Requires access right: PUBLIC, LOGGED_IN, SCOPE

• generateDayOfWeek string

  Requires access right: PUBLIC, LOGGED_IN, SCOPE

• bitmaskDaysOfWeek string

  This is a bitmask value of the days of the week the event occurs on | Requires access right: PUBLIC, LOGGED_IN, SCOPE

• bitmaskHoursStart string

  This is a bitmask value of the hours an event starts on | Requires access right: PUBLIC, LOGGED_IN, SCOPE

• orderStringOne string

  Requires access right: PUBLIC, LOGGED_IN, SCOPE

• orderStringTwo string

  Requires access right: PUBLIC, LOGGED_IN, SCOPE

• startTime string

  Requires access right: PUBLIC, LOGGED_IN, SCOPE

• endTime string

  Requires access right: PUBLIC, LOGGED_IN, SCOPE

• slugIdentifier string

  Requires access right: PUBLIC, LOGGED_IN, SCOPE

• created string

  Requires access right: PUBLIC, LOGGED_IN, SCOPE

• updated string

  Requires access right: PUBLIC, LOGGED_IN, SCOPE

• minGradeLevel string

  Requires access right: PUBLIC, LOGGED_IN, SCOPE

• maxGradeLevel string

  Requires access right: PUBLIC, LOGGED_IN, SCOPE

• deleted boolean

  This property is used to mark an entity as deleted / archived | Requires access right: SCOPE

• requireAge boolean

  Requires access right: SCOPE

• requireGradeLevel boolean

  Requires access right: SCOPE

• searchString string

  text to search for in the list

• orderFieldName string

  name of the order field

• orderFieldSort string

  sorting mode

  Values are DESC or ASC.

• page integer

  page of the list

  Default value is 0.

• pageSize integer

  number of entries for each page

  Minimum value is 1, maximum value is 200. Default value is 50.

• withMaxPageNumber string

  returns the number of pages available as a header if this is set

• iw-build-id string

  build id of the client

• iw-package-id string

  package id of the client

Responses

• 200 application/json

  Returns a list of events

  Hide response attributes Show response attributes object

  • id integer
  • token string
  • public_keywords string
  • event_type string
  • age_group string
  • min_age integer
  • max_age integer
  • min_grade_level integer
  • max_grade_level integer
  • age_tolerance integer
  • event_people_limit integer
  • event_people_min_limit integer
  • hide_event_people_limit boolean
  • event_people_recovered_vaccinated_limit integer
  • event_people_not_recovered_vaccinated_limit integer
  • has_wait_list boolean
  • can_sign_up_for_main_event boolean
  • only_sign_up_for_main_event boolean
  • sign_up_limit_days_before integer
  • sign_up_limit_stop_days_before integer
  • sign_up_delete_hours_before integer
  • start_time string(date-time)
  • end_time string(date-time)
  • require_address boolean
  • require_contact boolean
  • require_billing boolean
  • allow_direct_billing boolean
  • require_age boolean
  • require_grade_level boolean
  • require_free_note_field_ids string
  • generate_new_bookings boolean
  • generate_new_bookings_v2 boolean
  • generate_ignore_sys_calendar boolean
  • copy_main_sign_ups_to_booking boolean
  • generate_hour_start string(date-time)
  • generate_hour_end string(date-time)
  • generate_day_of_week integer
  • bitmask_days_of_week integer
  • bitmask_hours_start integer
  • summarized_date_times string
  • customer_detail_cta string
  • customer_badge string
  • created string(date-time)
  • updated string(date-time)
  • address string
  • address_street string
  • address_house_number string
  • address_street_level string
  • address_co string
  • address_city string
  • address_zip string
  • address_admin_level1 string
  • address_country string
  • address_full_country string
  • address_geo_lat string
  • address_geo_lng string
  • address_external_provider_id string
  • main_phone string
  • main_fax string
  • main_email string
  • website string
  • name string
  • deleted boolean
  • unified_cat_ids object

    Additional properties are allowed.

  • unified_cat_names object

    Additional properties are allowed.

  • short_identifier string
  • image_url string
  • color string
  • fg_color string
  • slug_identifier string