Search team volunteers

Retrieve the volunteers on one of the plan's teams, including the positions they can fill, whether they are scheduled, and any scheduling conflicts or block-out dates.

Required permission: Full Read Service Plans

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required
≥ 1

The id of the plan

int32
required
≥ 1

The id of the team (group)

Query Params
int32
≥ 1

Restrict the results to volunteers who can fill this position, and their entries to that position.

int32
≥ 1

Restrict the position entries to this plan time. Useful for split teams, which serve per time.

string

Free text search across the volunteer's name, aliases, email, phone, and position name.

int32
≥ 0

The number of records to skip before returning results, used for paging.

int32
≥ 0

The maximum number of records to return per page. Defaults to 50.

string

The field to sort the results by. The default field depends on the endpoint.

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
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json