Search check-in sessions

get

https://{tenant}.onechurchsoftware.com/api/events/{id}/checkin/sessions

Retrieve the check-in sessions configured for the given event, including each session's station capabilities.

Required permission: Full Read Events

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

int32

required

≥ 1

The id of the event.

Query Params

name

string

Return sessions whose name contains the given text.

capabilities

string

Comma-delimited list of capability ids. Returns sessions with at least one of the given capabilities: 1 = can add people, 2 = allows visitors, 3 = can send text messages, 4 = shows birthdays, 5 = can manage rosters, 6 = restricts by position, 7 = requires a group.

theme

string

Comma-delimited list of theme ids. Use -1 to include sessions without a theme.

active

boolean

Whether to return active or inactive sessions.

groups

boolean

When true, each session includes the groups it checks people into.

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

404Not Found