Get event feed

get

https://{tenant}.onechurchsoftware.com/api/events/calendar

Retrieve event occurrences in a form suited to rendering a calendar. For event metadata and repeating schedules, use search events instead.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

name

string

Returns events where the name contains the given text.

description

string

Returns events where the description contains the given text.

date.start

date-time

Include events starting on or after this date and time (UTC).

date.end

date-time

Include events starting on or before this date and time (UTC).

start

date-time

The start of the feed window (UTC). Events overlapping the window are included. Defaults to one day ago.

end

date-time

The end of the feed window (UTC). Events overlapping the window are included. Defaults to 12 months from now.

active

boolean

If true, returns today's and future events. If false, returns events that have passed.

listed

boolean

Whether to return events that are currently set as listed.

calendar

string

Comma-delimited list of calendar ids. Values come from /api/calendars.

campus

string

Comma-delimited list of campus ids. Events without a campus are always included. Values come from /api/locations.

location

int32

≥ 1

A single campus id. Unlike campus, restricts results to events assigned to this campus only. Values come from /api/locations.

zipCode

string

If provided, returns all events within a 10 mile radius of the given zip code (estimated).

weekday

string

Comma-delimited list of weekday names. Returns events starting on the given days of the week.

organizer

int32

≥ 1

The person id of an organizer whose events should be returned.

registration

boolean

Whether to return events which require registration or not.

trackAttendance

boolean

Whether to return events which are tracking attendance via the check-in system.

category

string

Comma-delimited list of category ids. Values come from /api/property_values/event_types/values.

period

string

Returns events matching the given time period, overriding date.start and date.end. Accepted values are: today, tomorrow, this_week, next_week, this_month, next_month.

group

int32

≥ 1

If set, returns events on the given group's calendar.

event

int32

≥ 1

The parent event id. If set, returns all child occurrences under the parent event.

featured

boolean

Whether to return only featured events (true) or only non-featured events (false).

form

int32

The id of a sign-up form. Use -1 to include only events without a sign-up form. Values come from /api/forms.

public

boolean

Whether the event is visible to the public (inherited from its calendar).

shortDescription

boolean

Whether to truncate event descriptions in the response. Defaults to true.

filter

string

Returns events where the name or description contains the given words.

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. By default all matching records are returned.

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