---
title: "Get open availability"
method: GET
path: "/calendar/availability"
tags: ["Calendar"]
---

# Get open availability

`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`)

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

## Query parameters

- `mailbox` string, email, required
- `from` string, date-time, required
- `to` string, date-time, required
- `duration` integer
- `interval` integer
- `timezone` string
- `days` string
- `window_start` integer
- `window_end` integer
- `buffer` integer
- `minimum_notice` integer

## Headers

- `X-Shipmail-Organization` string

## Response `200`

Open availability slots.

- CalendarAvailability
  - `object` 'calendar_availability', required
  - `mailbox` string, email, required
  - `from` string, date-time, required
  - `to` string, date-time, required
  - `duration_minutes` integer, required
  - `timezone` string, required
  - `slots` CalendarAvailabilitySlot[], required
    - `start` string, date-time, required
    - `end` string, date-time, required

## Other responses

- `404`: Resource not found.
- `422`: Validation failed.
- `429`: Rate limit exceeded.

---

[API](https://skmtc.dev/shipmail/apis/shipmail-api.md) · [All operations](https://skmtc.dev/shipmail/apis/shipmail-api/llms.txt) · [OpenAPI document](https://skmtc.dev/shipmail/apis/shipmail-api/revisions/2c23e59d7e30?raw)