Search serving opportunities

get

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

Retrieve open serving slots on upcoming plans that the signed-in person could fill. Each opportunity is an unfilled position need; whether the person can sign up depends on the position's sign-up option and their team membership.

Required permission: Full Read Service Plans

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

date.start

date-time

Include opportunities on plans with a time on or after this date.

date.end

date-time

Include opportunities on plans with a time on or before this date.

group

string

Include opportunities whose team name contains this text.

position

string

Include opportunities whose position name contains this text.

campus

string

Comma-delimited list of campus (location) ids. Use -1 to include opportunities on plans without a location.

description

string

Include opportunities whose position description contains this text.

type

string

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

status

string

Comma-delimited list of availability codes to include: "available" (open to the signed-in person with slots remaining), "not_available" (full or closed to them), and "scheduled" (they have accepted an assignment).

filter

string

Free text search across the position and team names.

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