Search service types

get

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

Retrieve a list of service types matching the given filters. Service types categorize plans (e.g. a weekly worship service) and carry the teams, templates, and attachments used when creating plans.

Required permission: Full Read Service Plans

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

name

string

Include service types which contain this text in the name.

description

string

Include service types which contain this text in the description.

teams.start

double

Include service types with at least this many teams.

teams.end

double

Include service types with at most this many teams.

templates.start

double

Include service types with at least this many templates.

templates.end

double

Include service types with at most this many templates.

files.start

double

Include service types with at least this many attachments.

files.end

double

Include service types with at most this many attachments.

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