Search Checkins

GET

api

spaces

checkins

Search Checkins

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

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 a customer’s access to a location using an eligible pass. The system first selects an eligible customer or shared pass; when none is available, it creates a customer pay-as-you-go pass only when the location enables pay-as-you-go and has a valid pass for that customer type. A pay-as-you-go check-in starts with no charge and, at checkout, is charged by duration or fixed pass price subject to the location’s daily minimum and maximum settings. Check-ins can be opened or closed manually or through access, network, sensor, tile, or booking integrations.

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
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 customer checking in. The customer must be active; the system first uses an eligible customer or shared pass, then can fall back to an eligible pay-as-you-go pass when the location allows it..

string

Filter by display value for Coworker.FullName..

integer

Filter by iD of the location where the customer checked in. The Admin Agent supplies the current location for create and update operations..

string

Filter by display value for Business.Name..

integer

Filter by read-only origin of the check-in: Manual, DoorAccess, NetworkActivity, Tile, Sensor, or Booking. New manual records default to Manual..

string

Filter by check-in start date and time, stored in UTC and rounded to the nearest 15 minutes. It must be earlier than ToTime when a checkout time is provided..

string

Filter by optional checkout date and time, stored in UTC and rounded to the nearest 15 minutes. Leave empty to keep the check-in open; when set, it must be later than FromTime..

boolean

Filter by system-calculated flag copied from the pass used for this check-in; it determines whether the duration counts against the customer’s plan limits..

string

Filter by internal GUID of the customer pass selected or created by check-in validation; choose an eligible pass through the check-in workflow instead..

boolean

Filter by internal flag set by automated check-in sources to request later checkout validation; it is not a manual check-in setting..

string

Filter by internal UTC timestamp of the most recent activity reported by a network or access-control integration for this open check-in..

string

Filter by internal comma-separated device MAC addresses captured by a network-activity check-in; this network identifier is managed by integrations..

string

Filter by system-generated comma-separated snapshot of the customer’s team names when the check-in was created..

string

Filter by system-generated comma-separated snapshot of the customer’s active plan names when the check-in was created..

string

Filter by internal scheduler job ID used to prevent duplicate automatic checkout validation for an open check-in..

string

Filter by internal location-local representation of FromTime generated for reporting; set FromTime instead..

string

Filter by internal location-local representation of ToTime generated for reporting; set ToTime instead..

Range Filters

string

Filter by check-in start date and time, stored in UTC and rounded to the nearest 15 minutes. It must be earlier than ToTime when a checkout time is provided. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by check-in start date and time, stored in UTC and rounded to the nearest 15 minutes. It must be earlier than ToTime when a checkout time is provided. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by optional checkout date and time, stored in UTC and rounded to the nearest 15 minutes. Leave empty to keep the check-in open; when set, it must be later than FromTime. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by optional checkout date and time, stored in UTC and rounded to the nearest 15 minutes. Leave empty to keep the check-in open; when set, it must be later than FromTime. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by internal UTC timestamp of the most recent activity reported by a network or access-control integration for this open check-in. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by internal UTC timestamp of the most recent activity reported by a network or access-control integration for this open check-in. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by internal location-local representation of FromTime generated for reporting; set FromTime instead. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by internal location-local representation of FromTime generated for reporting; set FromTime instead. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by internal location-local representation of ToTime generated for reporting; set ToTime instead. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by internal location-local representation of ToTime generated for reporting; set ToTime instead. 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
}

Search Checkins

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

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