calendar-events

Get expanded calendar events

Changed on

Get expanded calendar events including materialized recurring instances.

get/calendar-events/expanded{format}

Request

  • The document declares no server URL.
  • Auth: one of:
    • HTTP bearer
    • API key in cookie sessionid

Path parameters

format'.json' required

Query parameters

calendarnumber

Filter by calendar ID

calendar_idinteger required

Calendar ID to get events for

end_timestring required

End datetime for the range (ISO format)

end_time_range_afterstring date-time

End time range

end_time_range_beforestring date-time

End time range

external_client_identifier_identifierstring

Filter by client identifier value. Must be supplied together with external_client_identifier_system.

external_client_identifier_systemstring

Filter by client identifier system. Must be supplied together with external_client_identifier_identifier.

limitinteger

Number of results to return per page.

offsetinteger

The initial index from which to return the results.

start_timestring required

Start datetime for the range (ISO format)

start_time_range_afterstring date-time

Start time range

start_time_range_beforestring date-time

Start time range

titlestring

Filter by partial title match

Headers

X-Organization-Idstring

Selects the active organization for this request. Optional for callers that belong to exactly one active organization — the single membership is resolved implicitly. Required when the caller has two or more active memberships; omitting it in that case returns 400. If the header names an organization the caller is not an active member of, the server returns 403.

Response

countinteger required
nextstring uri nullable
previousstring uri nullable

Changes

    • ▲

      removed the required property // from the response with the status

    • ○

      added the required property // to the response with the status

    • ○

      added the required property // to the response with the status