Calendar API

Authenticate every request with your API key:

CODEBLOCK0

API keys are created from the Agents tab in the dashboard, or via the setup flow below. Each key
is scoped to specific calendars with granular permissions: can_read, can_create, can_update,
can_delete, can_create_invitees, and can_update_invitees.

---

Setup (getting an API key)

If you don't have a cal_ API key yet, use the setup flow to let the user authorize access:

1. 1. Create a setup session (no auth required):

POST https://cal.limehouse.io/api/v1/setup/sessions

Response: INLINECODE7

1. 2. Direct the user to open setup_url in their browser. They will sign in, choose calendars, and

configure permissions.

1. 3. Poll for completion (every 3 seconds):

GET https://cal.limehouse.io/api/v1/setup/sessions/{token}/poll

Response while pending: { "status": "pending" } Response when complete: INLINECODE10

1. 4. Store the agent_token value. This is your API key for all subsequent requests.

The setup session expires after 30 minutes. If the agent cannot make HTTP requests, direct the user
to https://cal.limehouse.io/connect where they can create a key and copy it manually.

---

Get agent info

CODEBLOCK3

Get metadata about the current agent, including its name, description, permitted calendars with per-calendar permissions, and calendars the user owns that the agent does not yet have access to (connectedcalendarswithout_access).

Response
CODEBLOCK4

Use connected_calendars_without_access to discover calendars the agent could
request access to via POST /api/v1/agent/request-permission-change.

---

List accessible calendars

CODEBLOCK5

List all calendars the agent has access to, along with read/write permissions.

Response — array of calendar objects:

[
  { "id": 3, "name": "Work", "color": "#4285F4", "timezone": "America/New_York" }
]

---

List events

CODEBLOCK7

List events on a calendar, optionally filtered by a time range. If no calendar_id is provided, returns events from all calendars the agent has read access to. start and end accept either a full ISO 8601 datetime (e.g. "2026-03-05T00:00:00-08:00") or a date-only string (e.g. "2026-03-05") which is expanded to the full day in the user's timezone. Requires can_read. Filter results with optional query parameters.

Parameter	Type	Required	Description
INLINECODE16	integer	No	Filter to a specific calendar. If omitted, returns events from all readable calendars.
INLINECODE17

ISO 8601 datetime or date | No | ISO 8601 datetime for the event start. When a timezone parameter is provided, the datetime is interpreted as wall-clock time in that timezone (any UTC offset is ignored). Otherwise, include a UTC offset for non-UTC times, e.g. "2026-02-26T17:30:00-08:00". Naive datetimes (without offset) are treated as UTC. Also accepts a date-only string (e.g. "2026-03-05") which expands to start of day in the user's timezone. |
| end | ISO 8601 datetime or date | No | ISO 8601 datetime for the event end. Same timezone rules as start_time. Also accepts a date-only string which expands to end of day in the user's timezone. |

Response — array of event objects:

[
  {
    "id": 42,
    "uid": "abc123",
    "calendar_id": 3,
    "summary": "Team standup",
    "description": "Daily sync",
    "location": "Conference Room A",
    "start_time": "2024-01-15T09:00:00Z",
    "end_time": "2024-01-15T09:30:00Z",
    "all_day": false,
    "recurrence_rule": null,
    "invitees": [
      {"email": "alice@example.com", "name": "Alice", "rsvp": "ACCEPTED"},
      {"email": "bob@example.com", "name": null, "rsvp": "NEEDS-ACTION"}
    ],
    "etag": "v1",
    "created_at": "2024-01-01T00:00:00Z",
    "updated_at": "2024-01-01T00:00:00Z"
  }
]

---

Create an event

CODEBLOCK9

Create a new event on a calendar. Requires can_create. Returns 201 Created with the new event object. If invitees is non-empty, also requires can_create_invitees.

Field	Type	Required	Description
INLINECODE23	string	Yes	Event title (1–255 chars)
INLINECODE24

string | No | Event description |
| location | string | No | Physical address or virtual meeting link for the event. |
| start_time | ISO 8601 datetime | Yes | ISO 8601 datetime for the event start. When a timezone parameter is provided, the datetime is interpreted as wall-clock time in that timezone (any UTC offset is ignored). Otherwise, include a UTC offset for non-UTC times, e.g. "2026-02-26T17:30:00-08:00". Naive datetimes (without offset) are treated as UTC. |
| end_time | ISO 8601 datetime | Yes | ISO 8601 datetime for the event end. Same timezone rules as start_time. |
| all_day | boolean | No | Default: false |
| timezone | string | No | IANA timezone name (e.g. "America/LosAngeles"). When provided, starttime and end_time are interpreted as wall-clock times in this timezone, and DST is handled automatically. |
| recurrence_rule| string | No | RRULE string for recurring events (e.g. "FREQ=WEEKLY;BYDAY=MO").|
| invitees | array | No | List of attendees. Each item: {"email": "...", "name": "..."}. For Google-connected calendars, Google will send invite emails (sendUpdates=all). |

Example request body

{
  "summary": "Team standup",
  "description": "Daily sync",
  "location": "Conference Room A",
  "start_time": "2024-01-15T09:00:00",
  "end_time": "2024-01-15T09:30:00",
  "timezone": "America/Los_Angeles",
  "invitees": [
    {"email": "alice@example.com", "name": "Alice"},
    {"email": "bob@example.com"}
  ]
}

---

Update an event

CODEBLOCK11

Update an existing event on a calendar. Only include the fields you want to change — omitted fields are left untouched. Never include starttime or endtime unless you are explicitly changing the time. Requires can_update. Returns 200 OK with the updated event object. If invitees is included in the request body, also requires can_update_invitees.

Sending invitees replaces the full attendee list (pass [] to remove all invitees).

Field	Type	Description
INLINECODE41	string	Event title (1–255 chars)
INLINECODE42

string | Event description |
| location | string | Physical address or virtual meeting link for the event. |
| start_time | ISO 8601 datetime | ISO 8601 datetime for the event start. When a timezone parameter is provided, the datetime is interpreted as wall-clock time in that timezone (any UTC offset is ignored). Otherwise, include a UTC offset for non-UTC times, e.g. "2026-02-26T17:30:00-08:00". Naive datetimes (without offset) are treated as UTC. |
| end_time | ISO 8601 datetime | ISO 8601 datetime for the event end. Same timezone rules as start_time. |
| all_day | boolean | Whether the event spans the full day |
| timezone | string | IANA timezone name (e.g. "America/LosAngeles"). When provided, starttime and end_time are interpreted as wall-clock times in this timezone, and DST is handled automatically. |
| recurrence_rule| string | RRULE string for recurring events (e.g. "FREQ=WEEKLY;BYDAY=MO").|
| invitees | array | Replace full attendee list (pass [] to clear) |

Example — rename an event (only send the field that changes):
CODEBLOCK12

Example — reschedule (only when intentionally changing the time):

{
  "start_time": "2024-01-15T10:00:00",
  "end_time": "2024-01-15T10:30:00",
  "timezone": "America/Los_Angeles"
}

---

Delete an event

CODEBLOCK14

Delete an event from a calendar. Requires can_delete. Returns 204 No Content.

---

Add travel time

CODEBLOCK15

Add a travel time buffer event before an existing event using Google Maps directions. Creates a new event that ends when the target event starts, with duration based on the calculated travel time. Requires can_read + can_create.
The target event must have a location set.

Field	Type	Required	Description
INLINECODE56	string	Yes	Travel mode — one of "walking", "driving", "biking", or "transit". For transit, the route is planned to arrive by the event's start time.
INLINECODE57

string | No | Where the user is traveling from — "home", "work", or "custom". If not specified, uses the location of the previous event on the same day, or falls back to the user's home address. |
| start_location_address | string | No | Custom start address. Required when startlocationtype is "custom". |

Example request body
CODEBLOCK16

Response — 201 Created:
CODEBLOCK17

The user's home and work addresses are set via PUT /api/v1/auth/me/preferences with
home_address and/or work_address fields.

---

Request a calendar connection

CODEBLOCK18

Request the user to connect a new calendar provider. Returns a confirmation URL that the user must visit to authorize the connection. The agent cannot connect the calendar directly — the user must click the link and approve.

Field	Type	Required	Description
INLINECODE63	string	Yes	The calendar provider to connect — "google" or "microsoft".

Response — 201 Created:
CODEBLOCK19

Surface the confirmation_url in chat so the user can click it.

---

Request a permission change

CODEBLOCK20

Request the user to grant or change this agent's permissions on a calendar. Returns a confirmation URL that the user must visit to approve the change. The requested permissions are suggestions — the user can adjust them before confirming.

Field	Type	Required	Description
INLINECODE66	integer	Yes	The ID of the calendar.
INLINECODE67

object | Yes | Permission flags (see below) |

requested_permissions fields (all boolean, all optional — defaults to current value):

Key	Description
INLINECODE69	Request read access to events on this calendar.
INLINECODE70

Request permission to create events on this calendar. |
| can_update | Request permission to update events on this calendar. |
| can_delete | Request permission to delete events on this calendar. |
| can_create_invitees| Add invitees when creating events |
| can_update_invitees| Modify invitees when updating |

Response — 201 Created:
CODEBLOCK21

If a matching pending request already exists, returns 409 with the existing URL.

Tip: Call GET /api/v1/agent/me first to see which calendars the agent already
has access to and which ones it doesn't (connected_calendars_without_access).

---

Error responses

Status	Meaning
INLINECODE79	Missing or invalid API key
INLINECODE80

Key exists but lacks permission — use request-permission-change |
| 404 Not Found | Calendar or event does not exist |
| 409 Conflict | A pending confirmation already exists (returns the existing URL) |

---

Quick-start (curl)

CODEBLOCK22