Returns a list of BaseEventInvitation objects

GET /api/event/base_event_invitation

Session token Jwt token internal Login config

Query parameters

id integer

Requires access right: LOGGED_IN_EXPLICIT, SCOPE
read boolean

Requires access right: LOGGED_IN_EXPLICIT, SCOPE
baseEvent string

Requires access right: LOGGED_IN_EXPLICIT, SCOPE
company string

Requires access right: SCOPE
person string

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 BaseEventInvitation objects
Hide response attributes Show response attributes object
- baseEvent object
  
  Hide baseEvent attributes Show baseEvent attributes object
  
  id integer
  
  event_type string
  
  event_people_limit integer
  
  event_people_min_limit integer
  
  hide_event_people_limit boolean
  
  has_wait_list boolean
  
  can_sign_up_for_main_event boolean
  
  only_sign_up_for_main_event boolean
  
  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
  
  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
  
  name string
  
  image_url string
- id integer
- read boolean
- message string
- reply_message string

GET /api/event/base_event_invitation

curl \
 --request GET 'https://replace-with-own-host.iw-erp.de/api/event/base_event_invitation' \
 --header "x-session-token: $API_KEY"

Response examples (200)

[
  {
    "baseEvent": {
      "id": 42,
      "event_type": "string",
      "event_people_limit": 42,
      "event_people_min_limit": 42,
      "hide_event_people_limit": true,
      "has_wait_list": true,
      "can_sign_up_for_main_event": true,
      "only_sign_up_for_main_event": true,
      "start_time": "2025-05-04T09:42:00Z",
      "end_time": "2025-05-04T09:42:00Z",
      "require_address": true,
      "require_contact": true,
      "require_billing": true,
      "allow_direct_billing": true,
      "require_age": true,
      "require_grade_level": true,
      "require_free_note_field_ids": "string",
      "generate_new_bookings": true,
      "generate_new_bookings_v2": true,
      "generate_ignore_sys_calendar": true,
      "generate_hour_start": "2025-05-04T09:42:00Z",
      "generate_hour_end": "2025-05-04T09:42:00Z",
      "generate_day_of_week": 42,
      "bitmask_days_of_week": 42,
      "bitmask_hours_start": 42,
      "summarized_date_times": "string",
      "customer_detail_cta": "string",
      "customer_badge": "string",
      "name": "string",
      "image_url": "string"
    },
    "id": 42,
    "read": true,
    "message": "string",
    "reply_message": "string"
  }
]