API Reference
  1. One Church Software API
  2. Service Plans

Search assignments

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

Retrieve the volunteer assignments on the given plans, grouped by person. Only assignments on teams the caller can manage are returned.

Required permission: Full Read Service Plans

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required

Comma-delimited list of plan ids to retrieve assignments for.

string

Comma-delimited list of plan time ids. Only assignments scheduled for one of these times are included.

string

Comma-delimited list of team (group) ids.

string

Comma-delimited list of assignment status ids to include: 0 = not contacted, 1 = accepted, 2 = declined, 3 = pending.

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.

Updated about 2 months ago

Did this page help you?
Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json

Updated about 2 months ago

Did this page help you?