Get plan teams

get

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

Retrieve the serving teams on a plan, including each team's position needs, volunteer assignments, and response status counts. Split teams are returned once per service time.

Required permission: Full Read Service Plans

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

plan

int32

required

≥ 1

The id of the plan

Query Params

person

string

Include only needs with an assignment whose volunteer matches this text (name, alias, email, or phone).

status

string

Comma-delimited list of assignment status ids to include: 0 = not contacted, 1 = accepted, 2 = declined, 3 = pending. Only needs with a matching assignment are returned.

team

string

Comma-delimited list of team (group) ids.

time

string

Comma-delimited list of plan time ids. Assignments scheduled for other times are removed. Include -1 to keep assignments with no specific time.

position

string

Include only needs whose position name contains this text.

remaining

boolean

When true, include only needs that still have open slots. When false, include only fully assigned needs.

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

404Not Found