Get one Checkin

GET

api

spaces

checkins

{id}

Get one Checkin

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

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

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

{
  "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 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-Read role.

Path Parameters

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"

const response = await fetch(
  'https://spaces.nexudus.com/api/spaces/checkins/87654321',
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const record = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/spaces/checkins/87654321',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

record = response.json()

Response

200

integer

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

Display value for Coworker.FullName..

integer

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

string

Display value for Business.Name..

integer

Read-only origin of the check-in: Manual, DoorAccess, NetworkActivity, Tile, Sensor, or Booking. New manual records default to Manual.. See eCheckinSource enum values: 1 = Manual, 2 = DoorAccess, 3 = NetworkActivity, 4 = Tile, 5 = Sensor.

string

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

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

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

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

boolean

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

string

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

string

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

string

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

string

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

string

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

string

Internal location-local representation of FromTime generated for reporting; set FromTime instead..

string

Internal location-local representation of ToTime generated for reporting; set ToTime instead..

integer

Unique record identifier.

string

UUID of the record.

string

Date and time the record was created (ISO 8601).

string

Date and time the record was last updated (ISO 8601).

string

Email of the user who last updated this record.

boolean

Whether the record was recently created.

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
}

Get one Checkin

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

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

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

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

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Path Parameters

Code Examples

Response

200

​Authentication

​Path Parameters

​Code Examples

​Response

​200

Authentication

Path Parameters

Code Examples

Response

200