Calendar

Get a calendar event

get/calendar/events/{id}

Request

  • Base URL: https://shipmail.to/api/v1
  • URL: https://shipmail.to/api/v1/calendar/events/{id}
  • 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.

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

Calendar event object.

object'calendar_event' required
idstring required
revisionstring required

Content revision to pass as expected_revision on a later update.

mailboxstring email required

The mailbox (calendar owner) address.

calendar_idstring nullable required
uidstring nullable required
titlestring nullable required
invitation_language'en' | 'fr' | 'es' required

Language used for Shipmail invitation, update, cancellation, and RSVP interface copy.

descriptionstring nullable required
locationstring nullable required
video_urlstring nullable required

Video/conference join URL (JSCalendar virtualLocation).

all_dayboolean required
startstring required

Timed events: a UTC instant. All-day events: a YYYY-MM-DD date.

endstring required

Timed events: a UTC instant. All-day events: the exclusive end date.

timezonestring nullable required

The event's own IANA time zone. Null for all-day or floating events.

durationstring nullable required

ISO 8601 duration, e.g. PT1H.

status'confirmed' | 'tentative' | 'cancelled' nullable required
free_busy_status'free' | 'busy' nullable required
privacy'public' | 'private' | 'secret' nullable required
colorstring nullable required
recurrence_idstring nullable required

Set on an expanded recurrence instance.

created_atstring date-time nullable required
updated_atstring date-time nullable required

Changes

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