Search plans

get

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

Retrieve a list of service plans matching the given filters.

Required permission: Full Read Service Plans

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

title

string

Include plans which contain this text in the title.

subtitle

string

Include plans which contain this text in the subtitle.

type

string

Comma-delimited list of service type ids or codes (e.g. plan_type_worship). Values come from /api/plans/servicetypes.

date.start

date-time

Include plans whose earliest date falls on or after this date and time.

date.end

date-time

Include plans whose earliest date falls on or before this date and time.

active

boolean

When true, include only plans with an upcoming time (or no times yet). When false, include only plans whose times have all passed.

public

boolean

Filter by whether the plan is shared publicly.

location

string

Comma-delimited list of location ids. Use -1 to include plans without a location.

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.

200OK