Search stations

get

https://{tenant}.onechurchsoftware.com/api/checkin/stations

Retrieve the check-in stations matching the given filters.

Required permission: Check-In

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

name

string

Include stations which contain this text in the name.

type

string

Comma-delimited list of station type ids: 1 = Text Search, 2 = Phone Pad, 3 = Roster Station.

theme

string

Comma-delimited list of check-in theme ids. Use -1 to include stations using the default theme.

keyboard

boolean

Whether the station shows an on-screen keyboard.

lastUsed.start

date-time

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

lastUsed.end

date-time

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

filter

string

Free text search on the station name.

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