Get calendars

get

https://{tenant}.onechurchsoftware.com/api/calendars

Retrieve the list of calendars, limited to the calendars the caller is allowed to see; unauthenticated requests receive only public calendars. Pass feeds=true to include a personal iCal subscription feed URL for each calendar. Without the Full Read Events permission, results are limited to public, group and serving calendars.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

feeds

boolean

When true, each calendar in the response includes a personal iCal subscription feed URL.

name

string

Filters calendars whose name contains the given text.

internal

boolean

When true, only internal feature calendars (group and serving events), whose events are managed elsewhere in the platform; when false, only regular event calendars.

locked

boolean

When true, only locked calendars (the built-in calendars, which cannot be renamed or deleted); when false, only user-created calendars.

events.start

double

Include calendars with at least this many events.

events.end

double

Include calendars with at most this many events.

future.start

double

Include calendars with at least this many upcoming events.

future.end

double

Include calendars with at most this many upcoming events.

earliest.start

date-time

Include calendars whose earliest event is on or after this date.

earliest.end

date-time

Include calendars whose earliest event is on or before this date.

latest.start

date-time

Include calendars whose latest event is on or after this date.

latest.end

date-time

Include calendars whose latest event is on or before this date.

next.start

date-time

Include calendars whose next upcoming event is on or after this date.

next.end

date-time

Include calendars whose next upcoming event is on or before this date.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Response

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

text/plain

application/json

text/json

200OK