Get person serving

get

https://{tenant}.onechurchsoftware.com/api/people/{id}/serving

Retrieve the person's serving assignments on service plans, including each assignment's plan, team group, position, response status and serving times.

Required permission: Limited Read People

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

int32

required

≥ 1

The id of the person.

Query Params

date.start

date-time

Return assignments with a serving time on or after this date.

date.end

date-time

Return assignments with a serving time on or before this date.

campus

string

Comma-delimited list of campus ids. Matches the service plan's campus; use -1 to include assignments on plans without a campus. Values come from /api/locations.

group

string

Return assignments where the serving team's group name contains the given text.

position

string

Return assignments where the position name contains the given text.

response

string

Comma-delimited list of response status ids: 0 = Not Contacted, 1 = Accepted, 2 = Declined, 3 = Pending.

past

boolean

When true, return only assignments whose serving times are all in the past; when false, only assignments with an upcoming serving time.

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