calendar-events

10 Endpunkte. Basis-URL: https://xapi.ambertech.cloud/api/v1

Entries in a date window, across the calendars this user may see#

GET/calendar/eventsToken

Parameter

Name	Ort	Typ	Beschreibung
`from`	Query	`string`	Start of the window, e.g. 2026-09-01
`to`	Query	`string`	End of the window, e.g. 2026-10-01
`calendar_ids`	Query	`string[]`	Calendars to read; comma separated or repeated. All visible ones when left out.
`tz`	Query	`string`	The reader's time zone, e.g. Europe/Berlin. Decides which day a ticket deadline lands on.

Antworten

200Entries returned
400Window missing, backwards or too wide

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/calendar/events" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Create an entry on a calendar#

POST/calendar/eventsToken

Request-Body`application/jsonCreateCalendarEventDto`

Name	Typ	Beschreibung
`calendar_id`Pflicht	`string`	–
`summary`Pflicht	`string`	–
`description`	`string`	–
`location`	`string`	–
`is_all_day`	`boolean`	Standard: `false`
`starts_at`	`string`	Timed start with its offset, e.g. 2026-09-24T09:00:00+02:00
`ends_at`	`string`	Timed end with its offset
`start_date`	`string`	All-day start, e.g. 2026-09-24
`end_date`	`string`	All-day end, exclusive: a single day ends on the next date
`timezone`	`string`	IANA time zone, e.g. Europe/Berlin
`meeting_provider`	`string`	Werte: `teamsgoogle_meetzoomcustom`
`meeting_url`	`string`	–
`meeting_id`	`string`	–
`generate_meeting`	`boolean`	Create the Zoom meeting rather than taking a pasted link
`zoom_options`	`ZoomMeetingOptionsDto`	How the generated Zoom meeting is set up; used only with generate_meeting
`custom_field_values`	`object`	Values of the custom fields the calendar shows, keyed by field key
`watcher_ids`	`string[]`	–
`links`	`CalendarEventLinkDto[]`	–
`links[].type`Pflicht	`string`	Werte: `taskprocessuserasset_object`
`links[].id`Pflicht	`string`	Id of the linked ticket, process, user or asset
`links[].remind`	`boolean`	For a linked person: false leaves them out of the reminders
`reminders`	`CalendarReminderDto[]`	This entry's reminders; null follows the calendar's default and an empty list turns them off
`reminders[].minutes_before`Pflicht	`number`	Werte: `051015306012014402880432057607200864010080`
`reminders[].channels`Pflicht	`string[]`	Werte: `notificationemail`
`reminders[].repeat_times`	`number`	Times to send it, spaced evenly up to the start; once when left out

Antworten

201Entry created
400Dates, time zone, fields, followers or links rejected
403Edit access to that calendar required

Beispiel (cURL)

curl -X POST "https://xapi.ambertech.cloud/api/v1/calendar/events" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"calendar_id":"…","summary":"…"}'

Read one entry#

GET/calendar/events/{id}Token

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	Entry UUID

Antworten

200Entry returned
404Not found, or its calendar is not visible

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/calendar/events/{id}" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Edit an entry#

PATCH/calendar/events/{id}Token

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	Entry UUID

Request-Body`application/jsonUpdateCalendarEventDto`

Name	Typ	Beschreibung
`summary`	`string`	–
`description`	`string`	–
`location`	`string`	–
`is_all_day`	`boolean`	Standard: `false`
`starts_at`	`string`	Timed start with its offset, e.g. 2026-09-24T09:00:00+02:00
`ends_at`	`string`	Timed end with its offset
`start_date`	`string`	All-day start, e.g. 2026-09-24
`end_date`	`string`	All-day end, exclusive: a single day ends on the next date
`timezone`	`string`	IANA time zone, e.g. Europe/Berlin
`meeting_provider`	`string`	Werte: `teamsgoogle_meetzoomcustom`
`meeting_url`	`string`	–
`meeting_id`	`string`	–
`generate_meeting`	`boolean`	Create the Zoom meeting rather than taking a pasted link
`zoom_options`	`ZoomMeetingOptionsDto`	How the generated Zoom meeting is set up; used only with generate_meeting
`custom_field_values`	`object`	Values of the custom fields the calendar shows, keyed by field key
`watcher_ids`	`string[]`	–
`links`	`CalendarEventLinkDto[]`	–
`links[].type`Pflicht	`string`	Werte: `taskprocessuserasset_object`
`links[].id`Pflicht	`string`	Id of the linked ticket, process, user or asset
`links[].remind`	`boolean`	For a linked person: false leaves them out of the reminders
`reminders`	`CalendarReminderDto[]`	This entry's reminders; null follows the calendar's default and an empty list turns them off
`reminders[].minutes_before`Pflicht	`number`	Werte: `051015306012014402880432057607200864010080`
`reminders[].channels`Pflicht	`string[]`	Werte: `notificationemail`
`reminders[].repeat_times`	`number`	Times to send it, spaced evenly up to the start; once when left out
`updated_at`	`string`	The updated_at the client last read. When it no longer matches, the edit is rejected instead of overwriting someone else.

Antworten

200Entry updated
409Someone else saved first; reload and try again

Beispiel (cURL)

curl -X PATCH "https://xapi.ambertech.cloud/api/v1/calendar/events/{id}" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"summary":"…","description":"…","location":"…"}'

Delete an entry#

DELETE/calendar/events/{id}Token

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	Entry UUID

Antworten

200Entry deleted
403Edit access to its calendar required

Beispiel (cURL)

curl -X DELETE "https://xapi.ambertech.cloud/api/v1/calendar/events/{id}" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Replace what an entry is linked to#

PUT/calendar/events/{id}/linksToken

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	Entry UUID

Request-Body`application/jsonSetCalendarEventLinksDto`

Name	Typ	Beschreibung
`links`Pflicht	`CalendarEventLinkDto[]`	–
`links[].type`Pflicht	`string`	Werte: `taskprocessuserasset_object`
`links[].id`Pflicht	`string`	Id of the linked ticket, process, user or asset
`links[].remind`	`boolean`	For a linked person: false leaves them out of the reminders

Antworten

200Links updated

Beispiel (cURL)

curl -X PUT "https://xapi.ambertech.cloud/api/v1/calendar/events/{id}/links" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"links":[]}'

Replace who follows an entry#

PUT/calendar/events/{id}/watchersToken

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	Entry UUID

Request-Body`application/jsonSetCalendarEventWatchersDto`

Name	Typ	Beschreibung
`watcher_ids`Pflicht	`string[]`	User ids that follow this event

Antworten

200Followers updated
400Someone named cannot see this calendar

Beispiel (cURL)

curl -X PUT "https://xapi.ambertech.cloud/api/v1/calendar/events/{id}/watchers" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"watcher_ids":[]}'

The current settings of the entry's Zoom meeting, read from Zoom#

GET/calendar/events/{id}/zoom-meetingToken

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	Entry UUID

Antworten

200Meeting options; never a token
400No Zoom meeting made here, or Zoom refused
404Meeting deleted inside Zoom

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/calendar/events/{id}/zoom-meeting" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Create the Zoom meeting for an entry that has no link yet#

POST/calendar/events/{id}/zoom-meetingToken

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	Entry UUID

Request-Body`application/jsonCreateZoomMeetingDto`

Name	Typ	Beschreibung
`zoom_options`	`ZoomMeetingOptionsDto`	–
`zoom_options.use_pmi`	`boolean`	Use the host personal meeting ID instead of a new one
`zoom_options.passcode_enabled`	`boolean`	Require a passcode to join
`zoom_options.passcode`	`string`	The passcode; left out, Zoom makes one. Up to 10 letters, digits or @ - _ *
`zoom_options.waiting_room`	`boolean`	–
`zoom_options.encryption_type`	`string`	Werte: `enhanced_encryptione2ee`
`zoom_options.host_video`	`boolean`	–
`zoom_options.participant_video`	`boolean`	–
`zoom_options.continuous_chat`	`boolean`	Let people use the meeting chat before and after
`zoom_options.join_before_host`	`boolean`	–
`zoom_options.mute_upon_entry`	`boolean`	–
`zoom_options.auto_recording`	`string`	Werte: `nonelocalcloud`
`zoom_options.recurrence`	`ZoomRecurrenceDto`	–

Antworten

201Entry returned with its link
400Already linked, has no start time, or came from elsewhere
403Edit access to the entry required

Beispiel (cURL)

curl -X POST "https://xapi.ambertech.cloud/api/v1/calendar/events/{id}/zoom-meeting" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"zoom_options":"…"}'

Change the settings of the entry's Zoom meeting#

PATCH/calendar/events/{id}/zoom-meetingToken

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	Entry UUID

Request-Body`application/jsonUpdateZoomMeetingDto`

Name	Typ	Beschreibung
`zoom_options`Pflicht	`ZoomMeetingOptionsDto`	–
`zoom_options.use_pmi`	`boolean`	Use the host personal meeting ID instead of a new one
`zoom_options.passcode_enabled`	`boolean`	Require a passcode to join
`zoom_options.passcode`	`string`	The passcode; left out, Zoom makes one. Up to 10 letters, digits or @ - _ *
`zoom_options.waiting_room`	`boolean`	–
`zoom_options.encryption_type`	`string`	Werte: `enhanced_encryptione2ee`
`zoom_options.host_video`	`boolean`	–
`zoom_options.participant_video`	`boolean`	–
`zoom_options.continuous_chat`	`boolean`	Let people use the meeting chat before and after
`zoom_options.join_before_host`	`boolean`	–
`zoom_options.mute_upon_entry`	`boolean`	–
`zoom_options.auto_recording`	`string`	Werte: `nonelocalcloud`
`zoom_options.recurrence`	`ZoomRecurrenceDto`	–

Antworten

200Entry returned with its link
400No Zoom meeting made here, or Zoom refused
404Meeting deleted inside Zoom
409Meeting still being created

Beispiel (cURL)

curl -X PATCH "https://xapi.ambertech.cloud/api/v1/calendar/events/{id}/zoom-meeting" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"zoom_options":"…"}'

calendar-events

Entries in a date window, across the calendars this user may see#

Parameter

Antworten

Create an entry on a calendar#

Request-Bodyapplication/jsonCreateCalendarEventDto

Antworten

Read one entry#

Parameter

Antworten

Edit an entry#

Parameter

Request-Bodyapplication/jsonUpdateCalendarEventDto

Antworten

Delete an entry#

Parameter

Antworten

Replace what an entry is linked to#

Parameter

Request-Bodyapplication/jsonSetCalendarEventLinksDto

Antworten

Replace who follows an entry#

Parameter

Request-Bodyapplication/jsonSetCalendarEventWatchersDto

Antworten

The current settings of the entry's Zoom meeting, read from Zoom#

Parameter

Antworten

Create the Zoom meeting for an entry that has no link yet#

Parameter

Request-Bodyapplication/jsonCreateZoomMeetingDto

Antworten

Change the settings of the entry's Zoom meeting#

Parameter

Request-Bodyapplication/jsonUpdateZoomMeetingDto

Antworten

Request-Body`application/jsonCreateCalendarEventDto`

Request-Body`application/jsonUpdateCalendarEventDto`

Request-Body`application/jsonSetCalendarEventLinksDto`

Request-Body`application/jsonSetCalendarEventWatchersDto`

Request-Body`application/jsonCreateZoomMeetingDto`

Request-Body`application/jsonUpdateZoomMeetingDto`