> ## Documentation Index
> Fetch the complete documentation index at: https://www.spacebring.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Retrieve check-ins
> Retrieve the check-ins of a location, newest arrival first. With bearer token authentication, the user must be an administrator of the location. OAuth
Required scopes: checkIns.readonly or checkIns
## OpenAPI
````yaml /assets/openapi.json get /check_ins/v1
openapi: 3.0.2
info:
title: Spacebring
version: 1.0.0
termsOfService: https://www.spacebring.com/terms
servers:
- url: https://api.spacebring.com
security: []
paths:
/check_ins/v1:
get:
tags:
- Check-ins
summary: Retrieve check-ins
description: >-
Retrieve the check-ins of a location, newest arrival first. With bearer
token authentication, the user must be an administrator of the location.
OAuth
Required scopes: checkIns.readonly or
checkIns
operationId: getCheckIns
parameters:
- in: query
name: checkInDate[gte]
required: false
description: >-
Filter check-ins whose arrival is on or after this date (ISO 8601).
Use with checkInDate[lte] for a range.
schema:
type: string
- in: query
name: checkInDate[lte]
required: false
description: >-
Filter check-ins whose arrival is on or before this date (ISO 8601).
Use with checkInDate[gte] for a range.
schema:
type: string
- in: query
name: limit
required: false
description: >-
Maximum number of check-ins per page. Defaults to 25 when omitted or
invalid; values above 100 are capped at 100.
schema:
type: integer
minimum: 1
maximum: 100
- in: query
name: locationRef
required: true
description: UUID of the location.
schema:
type: string
format: uuid
- in: query
name: nextPageToken
required: false
description: >-
Pagination token from nextPageToken in a previous response. Keep the
same filters when fetching the next page.
schema:
type: string
- in: query
name: status
required: false
description: >-
Comma-separated list of check-in statuses to filter by, e.g.
`scheduled,checkedIn`. Valid values: checkedIn, checkedOut,
scheduled, expired. Defaults to all statuses.
schema:
type: string
- in: query
name: type
required: false
description: >-
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.
schema:
type: string
- in: query
name: userRef
required: false
description: >-
UUID of the user to filter check-ins by. Defaults to check-ins of
every user.
schema:
type: string
format: uuid
- in: header
name: spacebring-network-id
schema:
type: string
format: uuid
required: false
description: >-
The id of the network. Required when using bearer token
authentication
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/getCheckIns'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/responseError'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/responseError'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/responseError'
security:
- BasicAuth: []
- OAuth2:
- checkIns.readonly
- checkIns
components:
schemas:
getCheckIns:
type: object
properties:
checkIns:
type: array
items:
type: object
properties:
booking:
description: Booking this check-in was created for, if any.
type: object
properties:
id:
type: string
format: uuid
description: ID of the booking.
required:
- id
additionalProperties: false
checkInDate:
description: ISO timestamp of when the user checked in.
type: string
format: date-time
checkInScheduleRef:
description: >-
ID of the schedule this check-in was opened under. Absent on
check-ins created before schedules were introduced.
type: string
format: uuid
checkOutDate:
description: ISO timestamp of when the user checked out.
type: string
format: date-time
code:
description: Confirmation code of the check-in.
type: string
createDate:
type: string
format: date-time
description: ISO timestamp of when the check-in was created.
endDate:
description: >-
ISO timestamp of when the check-in expires. Absent when it was
opened under a schedule without an end date, or with a
personal code.
type: string
format: date-time
eventTicket:
description: Event ticket this check-in was created for, if any.
type: object
properties:
eventRef:
type: string
format: uuid
description: ID of the event.
id:
type: string
format: uuid
description: ID of the event ticket.
required:
- eventRef
- id
additionalProperties: false
id:
type: string
format: uuid
description: Unique identifier of the check-in.
networkRef:
type: string
format: uuid
description: ID of the network this check-in belongs to.
locationRef:
type: string
format: uuid
description: ID of the location this check-in belongs to.
status:
type: string
enum:
- checkedIn
- checkedOut
- scheduled
- expired
description: Status of the check-in.
startDate:
type: string
format: date-time
description: ISO timestamp of when the check-in starts.
type:
type: string
enum:
- deskBooking
- roomBooking
- eventTicket
- visit
- subscription
description: What the check-in was created for.
user:
description: >-
The user this check-in is for, read from the users service so
the details are current.
type: object
properties:
email:
description: Email address of the user.
nullable: true
type: string
id:
type: string
format: uuid
description: Unique identifier of the user.
name:
description: First name of the user.
nullable: true
type: string
phoneNumber:
description: Phone number of the user.
nullable: true
type: string
photoUrl:
description: User profile photo URL.
nullable: true
type: string
surname:
description: Surname of the user.
nullable: true
type: string
required:
- id
additionalProperties: false
visit:
description: Visit this check-in was created for, if any.
type: object
properties:
id:
type: string
format: uuid
description: ID of the visit.
userHost:
description: >-
The host the visit is with, read from the users service so
the details are current.
type: object
properties:
id:
type: string
format: uuid
description: Unique identifier of the host.
name:
description: First name of the host.
nullable: true
type: string
surname:
description: Surname of the host.
nullable: true
type: string
required:
- id
additionalProperties: false
required:
- id
additionalProperties: false
required:
- createDate
- id
- networkRef
- locationRef
- status
- startDate
- type
additionalProperties: false
description: List of check-ins.
nextPageToken:
description: Pagination token to fetch the next page of results.
type: string
searchQueryNext:
description: >-
Search query parameters for the next page of results. Includes all
filters used to fetch the current page.
type: string
required:
- checkIns
additionalProperties: false
responseError:
type: object
properties:
message:
type: string
type:
type: string
securitySchemes:
BasicAuth:
type: http
description: >-
See our [authentication
documentation](https://www.spacebring.com/docs/developer/api/authentication#basic-authentication)
for how to authorize your requests
scheme: basic
OAuth2:
type: oauth2
description: >-
See our [authentication
documentation](https://www.spacebring.com/docs/developer/api/authentication#oauth2)
for how to authorize your requests
flows:
authorizationCode:
authorizationUrl: https://api.spacebring.com/oauth2/authorize
tokenUrl: https://api.spacebring.com/oauth2/token
refreshUrl: https://api.spacebring.com/oauth2/token
scopes:
benefits.readonly: Read benefits and applications
benefits: Read and write benefits and applications
checkIns.readonly: Read check-ins
checkIns: Read and write check-ins
community.readonly: Read community companies and memberships
community: Read and write community companies and memberships
events.readonly: Read events and tickets
events: Read and write events and tickets
feed.readonly: Read feed posts
feed: Read and write feed posts
invoices.readonly: Read contracts, credit notes, discounts and invoices
invoices: Read and write contract, credit notes, discounts and invoices
locations.readonly: Read locations
locations: Read and write locations
plans.readonly: Read plans
plans: Read and write plans
resources.readonly: Read resources and bookings
resources: Read and write resources and bookings
subscriptions.readonly: Read subscriptions
subscriptions: Read and write subscriptions
shop.readonly: Read products and orders
shop: Read and write products and orders
support.readonly: Read support tickets
support: Read and write support tickets
transactions.readonly: Read transactions
transactions: Read and write transactions
visitors.readonly: Read visitors
visitors: Read and write visitors
````