Search Checkins

GET

api

spaces

checkins

Search Checkins

curl --request GET \
  --url https://spaces.nexudus.com/api/spaces/checkins \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/spaces/checkins"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/spaces/checkins', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "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

eCheckinSource — Source values

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

Query Parameters

Pagination & Sorting

integer

default:"1"

The page number to retrieve.

integer

default:"25"

The number of records per page.

string

The property name to sort results by (e.g. Name, CreatedOn).

integer

Sort direction. 0 for ascending, 1 for descending.

Filters

integer

Filter by iD of the coworker linked to this record.

string

Filter by full name of the checked-in customer.

integer

Filter by iD of the business linked to this record.

string

Filter by name of the location where the check-in takes place.

integer

Filter by how the check-in was created (e.g. Manual, DoorAccess, NetworkActivity, NexIO Tile, or Sensor).

string

Filter by date and time the customer checked in.

string

Filter by date and time the customer checked out. Null while the check-in is still open.

boolean

Filter by whether counts towards plan limits is enabled.

string

Filter by unique identifier (GUID) for the coworker time pass.

boolean

Filter by whether auto checkout is enabled.

string

Filter by date/time value for last activity.

string

Filter by mAC addresses of devices detected during a network-activity check-in.

string

Filter by teams the customer belonged to when the check-in was recorded.

string

Filter by product (tariff) assigned to the customer when the check-in was recorded.

string

Filter by iD of the validate checkin job associated with this record.

string

Filter by date/time value for from time local.

string

Filter by date/time value for to time local.

Range Filters

string

Filter by date and time the customer checked in greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date and time the customer checked in less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

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.

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.

string

Filter by date/time value for last activity greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date/time value for last activity less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date/time value for from time local greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date/time value for from time local less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date/time value for to time local greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date/time value for to time local less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter records created on or after this date. Format: YYYY-MM-DDTHH:mm.

string

Filter records created on or before this date. Format: YYYY-MM-DDTHH:mm.

string

Filter records updated on or after this date. Format: YYYY-MM-DDTHH:mm.

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=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/spaces/checkins?' + new URLSearchParams({
    page: 1,
    size: 15,
    orderBy: 'CreatedOn',
    dir: 1 // Ascending
  }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/spaces/checkins',
    params={
        'page': 1,
        'size': 15,
        'orderBy': 'CreatedOn',
        'dir': 0 // Ascending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Filtering by CreatedOn

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

const response = await fetch(
  'https://spaces.nexudus.com/api/spaces/checkins?' + new URLSearchParams({
    Checkin_CreatedOn: 'example-value',
    orderBy: 'CreatedOn',
    dir: 1
  }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/spaces/checkins',
    params={
        'Checkin_CreatedOn': 'example-value',
        'orderBy': 'CreatedOn',
        'dir': 0 // Ascending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

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=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/spaces/checkins?' + new URLSearchParams({
    from_Checkin_UpdatedOn: '2025-01-01T00:00',
    to_Checkin_UpdatedOn: '2025-12-31T23:59',
    orderBy: 'UpdatedOn',
    dir: 1 // Descending
   }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/spaces/checkins',
    params={
        'from_Checkin_UpdatedOn': '2025-01-01T00:00',
        'to_Checkin_UpdatedOn': '2025-12-31T23:59',
        'orderBy': 'UpdatedOn',
        'dir': 1 // Descending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Response

200

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.

integer

Current page number.

integer

Number of records per page.

string

The field used for sorting.

integer

The sort direction (0 = ascending, 1 = descending).

integer

Index of the first item on the current page.

integer

Index of the last item on the current page.

integer

Total number of matching records across all pages.

integer

Total number of pages.

boolean

Whether there is a next page of results.

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
}

Get one CheckinRetrieve a single Checkin record by its Id.

Search Checkins

curl --request GET \
  --url https://spaces.nexudus.com/api/spaces/checkins \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/spaces/checkins"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/spaces/checkins', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Enums

Query Parameters

Filters

Range Filters

Code Examples

Simple listing

Filtering by CreatedOn

Range filters

Response

200

​Authentication

​Enums

​Query Parameters

​Pagination & Sorting

​Filters

​Range Filters

​Code Examples

​Simple listing

​Filtering by CreatedOn

​Range filters

​Response

​200

Authentication

Enums

Query Parameters

Pagination & Sorting

Filters

Range Filters

Code Examples

Simple listing

Filtering by CreatedOn

Range filters

Response

200