Calendar

List calendar events

List events in a time range for one mailbox's calendar. Set expand=true to return recurring events as individual instances.

get/calendar/events

Request

  • Base URL: https://shipmail.to/api/v1
  • URL: https://shipmail.to/api/v1/calendar/events
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://shipmail.to/api/auth/oauth2/authorize, token URL https://shipmail.to/api/auth/oauth2/token)

Query parameters

mailboxstring email required

The mailbox (calendar owner) address.

fromstring date-time required

Start of the range (UTC instant).

tostring date-time required

End of the range (UTC instant).

expandboolean

Expand recurring events into individual instances.

calendar_idstring

Restrict to a single calendar.

cursorstring

Opaque pagination cursor returned by the same list operation. Send it unchanged; do not parse, modify, or fabricate it.

limitinteger

Items per page (1-250, default 100).

Headers

X-Shipmail-Organizationstring

OAuth access tokens only. The organization ID this request acts on. Required when the OAuth connection was approved for several organizations (400 validation_error without it); optional with one. An organization the connection was not approved for returns 403 authorization_error. Ignored for API keys, which belong to one organization.

Response

Paginated list of calendar events.

Changes

No recorded changes to this operation across all 1 revision of this API.