Skip to main content
GET
/
api
/
spaces
/
checkins
/
{id}
{
  "CoworkerId": 123,
  "CoworkerFullName": "<string>",
  "BusinessId": 123,
  "BusinessName": "<string>",
  "Source": 123,
  "FromTime": "<string>",
  "ToTime": "<string>",
  "CountsTowardsPlanLimits": true,
  "CoworkerTimePassGuid": "<string>",
  "AutoCheckout": true,
  "LastActivity": "<string>",
  "MacAddresses": "<string>",
  "TeamsAtTheTimeOfCheckin": "<string>",
  "TariffAtTheTimeOfCheckin": "<string>",
  "ValidateCheckinJobId": "<string>",
  "FromTimeLocal": "<string>",
  "ToTimeLocal": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}
A Checkin records when a customer accessed a location. To check in, a customer must hold a valid pass (TimePass entity) that covers the location and the time of the check-in. If the customer does not have a valid pass but the location or network has one or more Pay As You Go passes configured, a pass is automatically assigned and charged to the customer at check-in time. Check-ins can be created manually, or opened and closed automatically by NexIO (the front-desk Nexudus tablet app), door-access systems, or IT-network integrations. The Source field indicates how the check-in was created.

Authentication

This endpoint requires OAuth2 authentication. Include a valid bearer token in the Authorization header. The authenticated user must be a full unrestricted administrator or have the Checkin-Read role.

Path Parameters

id
integer
required
The Id of the Checkin record to retrieve.

Code Examples

curl -X GET \
  "https://spaces.nexudus.com/api/spaces/checkins/87654321" \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

200

CoworkerId
integer
Coworker Id.
CoworkerFullName
string
Full name of the checked-in customer.
BusinessId
integer
Business Id.
BusinessName
string
Name of the location where the check-in takes place.
Source
integer
How the check-in was created (e.g. Manual, DoorAccess, NetworkActivity, NexIO Tile, or Sensor). See eCheckinSource enum values: 0 = None, 1 = Manual, 2 = DoorAccess, 3 = NetworkActivity, 4 = Tile, 5 = Sensor.
FromTime
string
Date and time the customer checked in.
ToTime
string
Date and time the customer checked out. Null while the check-in is still open.
CountsTowardsPlanLimits
boolean
Counts Towards Plan Limits.
CoworkerTimePassGuid
string
Coworker Time Pass Guid.
AutoCheckout
boolean
Auto Checkout.
LastActivity
string
Last Activity.
MacAddresses
string
MAC addresses of devices detected during a network-activity check-in.
TeamsAtTheTimeOfCheckin
string
Teams the customer belonged to when the check-in was recorded.
TariffAtTheTimeOfCheckin
string
Product (tariff) assigned to the customer when the check-in was recorded.
ValidateCheckinJobId
string
Validate Checkin Job Id.
FromTimeLocal
string
From Time Local.
ToTimeLocal
string
To Time Local.
Id
integer
Unique record identifier.
UniqueId
string
UUID of the record.
CreatedOn
string
Date and time the record was created (ISO 8601).
UpdatedOn
string
Date and time the record was last updated (ISO 8601).
UpdatedBy
string
Email of the user who last updated this record.
IsNew
boolean
Whether the record was recently created.
SystemId
string
External system identifier.
Example Response
{
  "CoworkerId": null,
  "CoworkerFullName": null,
  "BusinessId": 0,
  "BusinessName": null,
  "Source": 0,
  "FromTime": "2025-01-15T10:30:00Z",
  "ToTime": null,
  "CountsTowardsPlanLimits": false,
  "CoworkerTimePassGuid": null,
  "AutoCheckout": false,
  "LastActivity": null,
  "MacAddresses": null,
  "TeamsAtTheTimeOfCheckin": null,
  "TariffAtTheTimeOfCheckin": null,
  "ValidateCheckinJobId": null,
  "FromTimeLocal": null,
  "ToTimeLocal": null,
  "Id": 87654321,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "CreatedOn": "2025-01-10T08:00:00Z",
  "UniqueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "UpdatedBy": "admin@example.com",
  "IsNew": false,
  "SystemId": null,
  "ToStringText": "Checkin Example",
  "LocalizationDetails": null,
  "CustomFields": null
}