Search events

get

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

Retrieve information about events, including the metadata that defines each event and its repeating schedule. If you need information better suited to rendering a calendar, use the event feed 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).

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.

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).

filter

string

Free text search across event content. When set, results are returned in relevance order.

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.

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:

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