CalDAV

19 endpoints at a glance

Method	Path	Summary
GET	/caldav/accounts	List Accounts
POST	/caldav/accounts	Create Account
DELETE	/caldav/accounts/{account_id}	Delete Account
PUT	/caldav/accounts/{account_id}	Update Account
GET	/caldav/accounts/{account_id}/calendars	List Calendars For Account
PUT	/caldav/accounts/{account_id}/calendars	Save Calendars For Account
GET	/caldav/accounts/{account_id}/calendars/available	List Available Calendars For Account
POST	/caldav/accounts/{account_id}/set-default	Set Default Account
PATCH	/caldav/accounts/{account_id}/window	Update Account Window
GET	/caldav/calendars	List Calendars
PUT	/caldav/calendars	Save Calendars
GET	/caldav/calendars/available	List Available Calendars
DELETE	/caldav/connection	Delete Connection
GET	/caldav/connection	Get Connection
PUT	/caldav/connection	Save Connection
PUT	/caldav/connection/export-default	Set Default Calendar
PATCH	/caldav/connection/window	Update Window
POST	/caldav/sync	Sync Now
POST	/caldav/test	Test Connection

caldav

---

Test Connection

POST

/caldav/test

Parameters

Header Parameters

authorization

Request Body

application/json

{

  

"server_url": "string",

  

"username": "string",

  

"password": "string"

}

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

POST

/caldav/test

Playground

Headers

authorization

Body

Samples

---

List Accounts

GET

/caldav/accounts

All of the user's CalDAV accounts, default first.

Parameters

Header Parameters

authorization

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

GET

/caldav/accounts

Playground

Headers

authorization

Samples

---

Create Account

POST

/caldav/accounts

Add a NEW CalDAV account. Validates credentials against the server.

Doesn't pick calendars — that's a follow-up PUT to
/accounts/{id}/calendars.

Parameters

Header Parameters

authorization

Request Body

application/json

{

  

"server_url": "string",

  

"username": "string",

  

"password": "string",

  

"label": "string"

}

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

POST

/caldav/accounts

Playground

Headers

authorization

Body

Samples

---

Update Account

PUT

/caldav/accounts/{account_id}

Update one account's credentials (validated against the server).

Parameters

Header Parameters

authorization

Path Parameters

account_id*

Type

string

Required

Request Body

application/json

{

  

"server_url": "string",

  

"username": "string",

  

"password": "string",

  

"label": "string"

}

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

PUT

/caldav/accounts/{account_id}

Playground

Headers

authorization

Variables

Key

Value

account_id*

Body

Samples

---

Delete Account

DELETE

/caldav/accounts/{account_id}

Remove one account. Cascades its calendars (+ events, decision (1)).

Parameters

Header Parameters

authorization

Path Parameters

account_id*

Type

string

Required

Query Parameters

delete_events

Type

boolean

Default

true

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

DELETE

/caldav/accounts/{account_id}

Playground

Headers

authorization

Variables

Key

Value

account_id*

delete_events

Samples

---

Set Default Account

POST

/caldav/accounts/{account_id}/set-default

Make this account the default (the one legacy endpoints act on).

Parameters

Header Parameters

authorization

Path Parameters

account_id*

Type

string

Required

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

POST

/caldav/accounts/{account_id}/set-default

Playground

Headers

authorization

Variables

Key

Value

account_id*

Samples

---

Update Account Window

PATCH

/caldav/accounts/{account_id}/window

Per-account sliding-window override.

Parameters

Header Parameters

authorization

Path Parameters

account_id*

Type

string

Required

Request Body

application/json

{

  

"window_days_past": 0,

  

"window_days_future": 0

}

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

PATCH

/caldav/accounts/{account_id}/window

Playground

Headers

authorization

Variables

Key

Value

account_id*

Body

Samples

---

List Available Calendars For Account

GET

/caldav/accounts/{account_id}/calendars/available

Re-discover one account's calendars from its server.

Parameters

Header Parameters

authorization

Path Parameters

account_id*

Type

string

Required

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

GET

/caldav/accounts/{account_id}/calendars/available

Playground

Headers

authorization

Variables

Key

Value

account_id*

Samples

---

List Calendars For Account

GET

/caldav/accounts/{account_id}/calendars

The selected calendars belonging to one account.

Parameters

Header Parameters

authorization

Path Parameters

account_id*

Type

string

Required

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

GET

/caldav/accounts/{account_id}/calendars

Playground

Headers

authorization

Variables

Key

Value

account_id*

Samples

---

Save Calendars For Account

PUT

/caldav/accounts/{account_id}/calendars

Set one account's enabled calendar set (removed calendars cascade).

Parameters

Header Parameters

authorization

Path Parameters

account_id*

Type

string

Required

Request Body

application/json

{

  

"urls": [

  

  

"string"

  

]

}

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

PUT

/caldav/accounts/{account_id}/calendars

Playground

Headers

authorization

Variables

Key

Value

account_id*

Body

Samples

---

Get Connection

GET

/caldav/connection

LEGACY: the default account's connection state (sans password).

Parameters

Header Parameters

authorization

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

GET

/caldav/connection

Playground

Headers

authorization

Samples

---

Save Connection

PUT

/caldav/connection

LEGACY: save credentials — updates the default account, or creates
the first one. Validates them against the server first.

Parameters

Header Parameters

authorization

Request Body

application/json

{

  

"server_url": "string",

  

"username": "string",

  

"password": "string"

}

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

PUT

/caldav/connection

Playground

Headers

authorization

Body

Samples

---

Delete Connection

DELETE

/caldav/connection

LEGACY: disconnect the user — removes ALL accounts and calendars.

Parameters

Header Parameters

authorization

Query Parameters

delete_events

Type

boolean

Default

true

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

DELETE

/caldav/connection

Playground

Headers

authorization

Variables

Key

Value

delete_events

Samples

---

Update Window

PATCH

/caldav/connection/window

LEGACY: sliding-window override on the DEFAULT account.

Parameters

Header Parameters

authorization

Request Body

application/json

{

  

"window_days_past": 0,

  

"window_days_future": 0

}

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

PATCH

/caldav/connection/window

Playground

Headers

authorization

Body

Samples

---

List Available Calendars

GET

/caldav/calendars/available

LEGACY: re-discover from the DEFAULT account's server.

Parameters

Header Parameters

authorization

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

GET

/caldav/calendars/available

Playground

Headers

authorization

Samples

---

List Calendars

GET

/caldav/calendars

All selected calendars across every account.

Parameters

Header Parameters

authorization

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

GET

/caldav/calendars

Playground

Headers

authorization

Samples

---

Save Calendars

PUT

/caldav/calendars

LEGACY: set the DEFAULT account's enabled calendar set.

Parameters

Header Parameters

authorization

Request Body

application/json

{

  

"urls": [

  

  

"string"

  

]

}

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

PUT

/caldav/calendars

Playground

Headers

authorization

Body

Samples

---

Sync Now

POST

/caldav/sync

Parameters

Header Parameters

authorization

Request Body

application/json

{

  

"calendar_id": "string"

}

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

POST

/caldav/sync

Playground

Headers

authorization

Body

Samples

---

Set Default Calendar

PUT

/caldav/connection/export-default

Store / clear the user's default export calendar.

The flag lives on the calendar doc (is_export_default) — a
connection no longer identifies a calendar now that a user can have
several accounts.

Parameters

Header Parameters

authorization

Request Body

application/json

{

  

"calendar_id": "string"

}

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

PUT

/caldav/connection/export-default

Playground

Headers

authorization

Body

Samples

---