Search check-in SMS templates

get

https://{tenant}.onechurchsoftware.com/api/checkin/sms/templates

Retrieve the text message templates available to check-in stations, matching the given filters.

Required permission: Check-In

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

isEnabled

boolean

Whether the template is enabled for use by stations.

name

string

Include templates which contain this text in the name.

usage.start

double

Include templates used at least this many times.

usage.end

double

Include templates used at most this many times.

message

string

Include templates which contain this text in the message body.

lastUsedOn.start

date-time

Include templates last used on or after this date (the church's timezone; time of day is ignored).

lastUsedOn.end

date-time

Include templates last used on or before this date (the church's timezone; time of day is ignored).

lastUsedByStation

string

Include templates last used by a station whose name contains this text.

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