Search calendars

get

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

Retrieve a paged list of calendars matching the given filters, including event counts and event date summaries for each calendar.

Required permission: Full Read Events

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

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.

skip

int32

≥ 0

The number of records to skip before returning results, used for paging.

limit

int32

≥ 0

The maximum number of records to return per page. Defaults to 50.

sort.property

string

The field to sort the results by. The default field depends on the endpoint.

sort.dir

string

enum

The sort direction: "asc" or "desc".

Allowed:

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

401

Authentication is required, or the Ocs-Api-Key header is missing or invalid.

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