Skip to main content
POST
/
api
/
spaces
/
checkins
{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<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-Create role.

Enums

ValueName
0None
1Manual
2DoorAccess
3NetworkActivity
4Tile
5Sensor

Request Body

Required Fields

BusinessId
integer
required
Business Id.
FromTime
string
required
Date and time the customer checked in.

Optional Fields

CoworkerId
integer
Coworker Id.
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.

Code Examples

curl -X POST \
  "https://spaces.nexudus.com/api/spaces/checkins" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "BusinessId": 0,
    "FromTime": "2025-01-15T10:30:00Z"
}'

Response

200

Status
integer
HTTP status code. 200 on success.
Message
string
A human-readable message confirming the creation.
Value
object
Contains the Id of the newly created record.
WasSuccessful
boolean
true if the checkin was created successfully.
Errors
array
null on success.
Example Response
{
  "Status": 200,
  "Message": "Checkin was successfully created.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}

400

Message
string
A summary of the validation error(s), in the format PropertyName: error message.
Value
any
null on validation failure.
Errors
object[]
Array of validation errors.
WasSuccessful
boolean
false when the request fails validation.
Example Response
{
  "Message": "FromTime: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "FromTime"
    }
  ],
  "WasSuccessful": false
}