Calendar view of events

Retrieves events for calendar display with flexible date range filtering.

Permission Requirements:

  • Employee users: Can access all events in their company's calendars.

  • Default Behavior:

  • If no date range parameters are provided, defaults to returning events for today only (from start of day to end of day in the user's timezone).

  • By default, filters by the authenticated user's calendars unless the users parameter is specified.

Response Format:

  • Returns a non-paginated array of events (not wrapped in pagination structure).
  • Events are returned in the same format as the list endpoint.
  • Useful for displaying events on calendar views where pagination is not needed.

Filtering:

Supports all the same filter parameters as the list endpoint, plus specific calendar and user filtering for calendar-specific views.

Query Params
date-time

Filter events that start on or after the specified date and time (ISO 8601 format). Defaults to start of today if not provided.

date-time

Filter events that end on or before the specified date and time (ISO 8601 format). Defaults to end of today if not provided.

string

Filter events by user IDs. Provide a comma-separated list of user IDs to show events from specific users' calendars. Defaults to the authenticated user's calendar if not specified.

string

Filter events by calendar IDs. Provide a comma-separated list of calendar IDs to filter events associated with specific calendars.

string

Filter events by tags. Provide a comma-separated list of tag names. Events matching any of the specified tags will be returned.

string
enum
Defaults to all

Filter by invitation status. Specify whether to show all events, only events the user is invited to, or events the user is not invited to.

Allowed:
integer

Filter events by associated job ID. Returns events linked to the specified job.

integer

Filter events by employee/user ID. Returns events associated with the specified user.

string

Filter events by trade name. Returns events associated with the specified trade.

string
enum
Defaults to no

Filter to show or hide material order related events. Defaults to no.

Allowed:
string
enum
Defaults to yes

Filter to show or hide work order related events. Defaults to yes.

Allowed:
string
enum
Defaults to yes

Filter to show or hide collection related events. Defaults to yes.

Allowed:
string
Responses

Language
Credentials
Header
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json