Skip to main content
GET
/
api
/
spaces
/
checkins
{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}
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-List role.

​
Enums

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

​
Query Parameters

​
Pagination & Sorting

​
page
integer
default:"1"
The page number to retrieve.
​
size
integer
default:"25"
The number of records per page.
​
orderBy
string
The property name to sort results by (e.g. Name, CreatedOn).
​
dir
integer
Sort direction. 1 for ascending, -1 for descending.

​
Filters

​
Checkin_Coworker
integer
Filter by Coworker Id.
​
Checkin_Coworker_FullName
string
Filter by full name of the checked-in customer.
​
Checkin_Business
integer
Filter by Business Id.
​
Checkin_Business_Name
string
Filter by name of the location where the check-in takes place.
​
Checkin_Source
integer
Filter by how the check-in was created (e.g. Manual, DoorAccess, NetworkActivity, NexIO Tile, or Sensor).
​
Checkin_FromTime
string
Filter by date and time the customer checked in.
​
Checkin_ToTime
string
Filter by date and time the customer checked out. Null while the check-in is still open.
​
Checkin_CountsTowardsPlanLimits
boolean
Filter by Counts Towards Plan Limits.
​
Checkin_CoworkerTimePassGuid
string
Filter by Coworker Time Pass Guid.
​
Checkin_AutoCheckout
boolean
Filter by Auto Checkout.
​
Checkin_LastActivity
string
Filter by Last Activity.
​
Checkin_MacAddresses
string
Filter by mAC addresses of devices detected during a network-activity check-in.
​
Checkin_TeamsAtTheTimeOfCheckin
string
Filter by teams the customer belonged to when the check-in was recorded.
​
Checkin_TariffAtTheTimeOfCheckin
string
Filter by product (tariff) assigned to the customer when the check-in was recorded.
​
Checkin_ValidateCheckinJobId
string
Filter by Validate Checkin Job Id.
​
Checkin_FromTimeLocal
string
Filter by From Time Local.
​
Checkin_ToTimeLocal
string
Filter by To Time Local.

​
Range Filters

​
from_Checkin_FromTime
string
Filter by date and time the customer checked in greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
​
to_Checkin_FromTime
string
Filter by date and time the customer checked in less than or equal to this value. Format: YYYY-MM-DDTHH:mm.
​
from_Checkin_ToTime
string
Filter by date and time the customer checked out. Null while the check-in is still open greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
​
to_Checkin_ToTime
string
Filter by date and time the customer checked out. Null while the check-in is still open less than or equal to this value. Format: YYYY-MM-DDTHH:mm.
​
from_Checkin_LastActivity
string
Filter by last activity greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
​
to_Checkin_LastActivity
string
Filter by last activity less than or equal to this value. Format: YYYY-MM-DDTHH:mm.
​
from_Checkin_FromTimeLocal
string
Filter by from time local greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
​
to_Checkin_FromTimeLocal
string
Filter by from time local less than or equal to this value. Format: YYYY-MM-DDTHH:mm.
​
from_Checkin_ToTimeLocal
string
Filter by to time local greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
​
to_Checkin_ToTimeLocal
string
Filter by to time local less than or equal to this value. Format: YYYY-MM-DDTHH:mm.
​
from_Checkin_CreatedOn
string
Filter records created on or after this date. Format: YYYY-MM-DDTHH:mm.
​
to_Checkin_CreatedOn
string
Filter records created on or before this date. Format: YYYY-MM-DDTHH:mm.
​
from_Checkin_UpdatedOn
string
Filter records updated on or after this date. Format: YYYY-MM-DDTHH:mm.
​
to_Checkin_UpdatedOn
string
Filter records updated on or before this date. Format: YYYY-MM-DDTHH:mm.

​
Code Examples

​
Simple listing

curl -X GET \
  "https://spaces.nexudus.com/api/spaces/checkins?page=1&size=15&orderBy=CreatedOn&dir=1" \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Filtering by CreatedOn

curl -X GET \
  "https://spaces.nexudus.com/api/spaces/checkins?Checkin_CreatedOn=example-value&orderBy=CreatedOn&dir=1" \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Range filters

curl -X GET \
  "https://spaces.nexudus.com/api/spaces/checkins?from_Checkin_UpdatedOn=2025-01-01T00:00&to_Checkin_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=-1" \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Response

​
200

​
Records
Checkin[]
The list of Checkin records matching the query. See the Get one Checkin endpoint for the full list of properties returned for each record.
​
CurrentPage
integer
Current page number.
​
CurrentPageSize
integer
Number of records per page.
​
CurrentOrderField
string
The field used for sorting.
​
CurrentSortDirection
integer
The sort direction (1 = ascending, -1 = descending).
​
FirstItem
integer
Index of the first item on the current page.
​
LastItem
integer
Index of the last item on the current page.
​
TotalItems
integer
Total number of matching records across all pages.
​
TotalPages
integer
Total number of pages.
​
HasNextPage
boolean
Whether there is a next page of results.
​
HasPreviousPage
boolean
Whether there is a previous page of results.
Example Response
{
  "Records": [
    {
      "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
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "CreatedOn",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}