List published Calendar feeds

GET

/api/v1/calendar/feeds

const url = 'https://example.com/api/v1/calendar/feeds';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/v1/calendar/feeds \
  --header 'Authorization: Bearer <token>'

Requires a signed-in User. It returns feed definitions and their latest fetch status. Route: /api/v1/calendar/feeds. Inputs: . Safe reads can use bounded retries.

Authorizations

installationBearer
browserSession

Responses

200

application/json

Array<object>

Feed metadata returned to a signed-in User; it never contains a token.

object

active

required

boolean

color

required

string

detail

required

Full feeds keep event details; Busy-only feeds reveal only availability.

string

Allowed values: full busy_only

required

string

include_notes

required

boolean

include_tasks

required

boolean

last_fetched_ms

integer | null format: int64

last_user_agent

string | null

name

required

string

source

required

A feed source selects one owner-scoped collection of calendar data.

string

Allowed values: journal area calendar

source_id

string | null

Example

[
  {
    "detail": "full",
    "source": "journal"
  }
]