Search check-in logs

get

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

Retrieve check-in and check-out records matching the given filters. Results are ordered by check-in time.

Required permission: Full Read Events

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

event

int32

≥ 1

The id of the event to retrieve logs for.

attendee

int32

≥ 1

The id of the event attendee (guest-list entry) to retrieve logs for.

group

string

Comma-delimited list of group ids. Use -1 to include logs not linked to a group.

groupName

string

Include logs whose group name contains this text.

session

string

Comma-delimited list of check-in session ids.

name

string

Include logs whose person's first name, last name, or alias contains each of these words.

checkInStation

string

Include logs checked in by a station whose name contains this text.

checkOutStation

string

Include logs checked out by a station whose name contains this text.

identifier

string

Include logs whose security code (the code printed on the labels) contains this text.

gender

string

Comma-delimited list of gender ids. Values come from /api/property_values/gender/values.

pager.start

double

Include logs with a pager number of at least this value.

pager.end

double

Include logs with a pager number of at most this value.

in.start

date-time

Include logs checked in on or after this date (the church's timezone; time of day is ignored).

in.end

date-time

Include logs checked in on or before this date (the church's timezone; time of day is ignored).

out.start

date-time

Include logs checked out on or after this date (the church's timezone; time of day is ignored).

out.end

date-time

Include logs checked out on or before this date (the church's timezone; time of day is ignored).

personId

int32

≥ 1

The id of the person to retrieve logs for.

familyId

int32

≥ 1

The id of the family to retrieve logs for.

string

Include logs whose person's or guest's email address contains this text.

phone

string

Include logs whose person's or guest's phone number 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.

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

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

text/plain

application/json

text/json

200OK