v1

latestOpenAPI 3.0.12026-08-063985821.3 MB
Event Scheduling API:Events

Find events

get/events

Query parameters

Titlestring
StartDatestring date-time

Search for events starting at specific date and time (UTC assumed).

When you pass the StartDate parameter, the result includes all events that have a start time greater than or equal to the provided start date.

EndDatestring date-time

Search for events ending at specific date and time (UTC assumed).

When you pass the EndDate parameter, the result includes all events that have a end time lesser than or equal to the provided end date.

EventTypestring
EventSubTypeIdsinteger[]
OrganizerIdinteger
EventIdsinteger[]
JobIdsinteger[]
CandidateIdsinteger[]
ContactIdsinteger[]
UserIdsinteger[]
CreatedByinteger
Embedstring[]

Embed related resources.<br /> Resources available to embed are: self, evaluations

Offsetinteger

The index of the first entry to return from the resource collection

Limitinteger

The maximum number of entries to return.<br /> Setting to 0 will return only the total count of matching resources.

Response

List of events matching the specified criteria

totalCountinteger required
pageNumberinteger
pageSizeinteger