Skip to main content
GET
Retrieve check-ins

Authorizations

Authorization
string
header
required

See our authentication documentation for how to authorize your requests

Headers

spacebring-network-id
string<uuid>

The id of the network. Required when using bearer token authentication

Query Parameters

checkInDate[gte]
string

Filter check-ins whose arrival is on or after this date (ISO 8601). Use with checkInDate[lte] for a range.

checkInDate[lte]
string

Filter check-ins whose arrival is on or before this date (ISO 8601). Use with checkInDate[gte] for a range.

limit
integer

Maximum number of check-ins per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100.

Required range: 1 <= x <= 100
locationRef
string<uuid>
required

UUID of the location.

nextPageToken
string

Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page.

status
string

Comma-separated list of check-in statuses to filter by, e.g. scheduled,checkedIn. Valid values: checkedIn, checkedOut, scheduled, expired. Defaults to all statuses.

type
string

Comma-separated list of check-in types to filter by, e.g. eventTicket,visit. Valid values: deskBooking, roomBooking, eventTicket, visit, subscription. Defaults to all types.

userRef
string<uuid>

UUID of the user to filter check-ins by. Defaults to check-ins of every user.

Response

OK

checkIns
object[]
required

List of check-ins.

nextPageToken
string

Pagination token to fetch the next page of results.

searchQueryNext
string

Search query parameters for the next page of results. Includes all filters used to fetch the current page.