Calendar

Get open availability

Compute open meeting slots for one mailbox from its own calendar. Derived app-side (not a cross-user free/busy lookup).

get/calendar/availability

Request

  • Base URL: https://shipmail.to/api/v1
  • URL: https://shipmail.to/api/v1/calendar/availability
  • 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).

durationinteger

Meeting length in minutes (default 30).

intervalinteger

Step between candidate slot starts in minutes (default = duration).

timezonestring

IANA time zone the working window is defined in (default Etc/UTC).

daysstring

Comma-separated weekdays offered, 0=Sunday .. 6=Saturday (default 1,2,3,4,5).

window_startinteger

Start of the daily window, minutes from midnight (default 540).

window_endinteger

End of the daily window, minutes from midnight (default 1020).

bufferinteger

Padding around busy intervals in minutes (default 0).

minimum_noticeinteger

Minimum notice before the first slot in minutes (default 0).

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

Open availability slots.

object'calendar_availability' required
mailboxstring email required
fromstring date-time required
tostring date-time required
duration_minutesinteger required
timezonestring required

Changes

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