Get one FailedCheckin

GET

api

spaces

failedcheckins

{id}

Get one FailedCheckin

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

import requests

url = "https://spaces.nexudus.com/api/spaces/failedcheckins/{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/failedcheckins/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "CoworkerId": 123,
  "CoworkerFullName": "<string>",
  "BusinessId": 123,
  "BusinessName": "<string>",
  "CheckinAttemptTime": "<string>",
  "Source": 123,
  "MacAddresses": "<string>",
  "TeamsAtTheTimeOfCheckin": "<string>",
  "TariffAtTheTimeOfCheckin": "<string>",
  "Description": "<string>",
  "CheckinAttemptTimeLocal": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

A FailedCheckin records an unsuccessful check-in attempt by a coworker (see Checkin entity). Each record captures the coworker involved, the location where the attempt occurred, the reason for the failure, and contextual details such as the coworker’s teams and tariff at the time. Failed check-ins are read-only and generated automatically by the system when a check-in is rejected — for example, due to access restrictions, an inactive plan, or an unrecognised device. Use the Description field to inspect the specific failure reason. The Source field indicates how the check-in was initiated (e.g. manual, Wi-Fi, app) and matches the eCheckinSource enum used by the Checkin entity.

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 FailedCheckin-Read role.

Path Parameters

integer

required

The Id of the FailedCheckin record to retrieve.

Code Examples

curl -X GET \
  "https://spaces.nexudus.com/api/spaces/failedcheckins/87654321" \
  -H "Authorization: Bearer YOUR_TOKEN"

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

const record = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/spaces/failedcheckins/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 coworker at the time of the failed check-in.

integer

ID of the business linked to this record.

string

Name of the location where the check-in was attempted.

string

Date and time when the check-in attempt occurred.

integer

Method used to initiate the check-in attempt (e.g. manual, Wi-Fi, app). See eCheckinSource enum values: 0 = None, 1 = Manual, 2 = DoorAccess, 3 = NetworkActivity, 4 = Tile, 5 = Sensor.

string

MAC addresses of the device used during the check-in attempt, if available.

string

Comma-separated list of teams the coworker belonged to at the time of the failed check-in.

string

Name of the pricing plan (tariff) assigned to the coworker at the time of the failed check-in.

string

Reason or explanation for why the check-in attempt failed.

string

Date/time value for checkin attempt 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,
  "CheckinAttemptTime": "2025-01-15T10:30:00Z",
  "Source": 0,
  "MacAddresses": null,
  "TeamsAtTheTimeOfCheckin": null,
  "TariffAtTheTimeOfCheckin": null,
  "Description": null,
  "CheckinAttemptTimeLocal": 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": "FailedCheckin Example",
  "LocalizationDetails": null,
  "CustomFields": null
}

Get multiple FailedCheckinsRetrieve multiple FailedCheckin records by their Ids in a single request.

Get one FailedCheckin

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

import requests

url = "https://spaces.nexudus.com/api/spaces/failedcheckins/{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/failedcheckins/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "CoworkerId": 123,
  "CoworkerFullName": "<string>",
  "BusinessId": 123,
  "BusinessName": "<string>",
  "CheckinAttemptTime": "<string>",
  "Source": 123,
  "MacAddresses": "<string>",
  "TeamsAtTheTimeOfCheckin": "<string>",
  "TariffAtTheTimeOfCheckin": "<string>",
  "Description": "<string>",
  "CheckinAttemptTimeLocal": "<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