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>'

import requests

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

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/{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 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-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 coworker linked to this record.

string

Full name of the checked-in customer.

integer

ID of the business linked to this record.

string

Name of the location where the check-in takes place.

integer

How the check-in was created (e.g. Manual, DoorAccess, NetworkActivity, NexIO Tile, or Sensor). See eCheckinSource enum values: 0 = None, 1 = Manual, 2 = DoorAccess, 3 = NetworkActivity, 4 = Tile, 5 = Sensor.

string

Date and time the customer checked in.

string

Date and time the customer checked out. Null while the check-in is still open.

boolean

Whether counts towards plan limits is enabled.

string

Unique identifier (GUID) for the coworker time pass.

boolean

Whether auto checkout is enabled.

string

Date/time value for last activity.

string

MAC addresses of devices detected during a network-activity check-in.

string

Teams the customer belonged to when the check-in was recorded.

string

Product (tariff) assigned to the customer when the check-in was recorded.

string

ID of the validate checkin job associated with this record.

string

Date/time value for from time local.

string

Date/time value for to time local.

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 multiple CheckinsRetrieve multiple Checkin records by their Ids in a single request.

Get one Checkin

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

import requests

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

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