Create Checkin

POST

api

spaces

checkins

Create Checkin

curl --request POST \
  --url https://spaces.nexudus.com/api/spaces/checkins \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "BusinessId": 123,
  "FromTime": "<string>"
}
'

import requests

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

payload = {
    "BusinessId": 123,
    "FromTime": "<string>"
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({BusinessId: 123, FromTime: '<string>'})
};

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

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<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-Create role.

Enums

eCheckinSource — Source values

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

Request Body

Required Fields

integer

required

ID of the business linked to this record.

string

required

Date and time the customer checked in.

Optional Fields

integer

ID of the coworker linked to this record.

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.

Code Examples

curl -X POST \
  "https://spaces.nexudus.com/api/spaces/checkins" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "BusinessId": 0,
    "FromTime": "2025-01-15T10:30:00Z"
}'

const response = await fetch(
  'https://spaces.nexudus.com/api/spaces/checkins',
  {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      BusinessId: 0,
      FromTime: '2025-01-15T10:30:00Z'
    })
  }
);

const data = await response.json();

import requests

response = requests.post(
    'https://spaces.nexudus.com/api/spaces/checkins',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'BusinessId': 0,
        'FromTime': '2025-01-15T10:30:00Z'
    }
)

data = response.json()

Response

200

integer

HTTP status code. 200 on success.

string

A human-readable message confirming the creation.

object

Contains the Id of the newly created record.

boolean

true if the checkin was created successfully.

array

null on success.

Example Response

{
  "Status": 200,
  "Message": "Checkin was successfully created.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}

400

string

A summary of the validation error(s), in the format PropertyName: error message.

any

null on validation failure.

object[]

Array of validation errors.

Show child attributes

any

The value that was submitted for the field, or null if missing.

string

The validation error message.

string

The name of the property that failed validation.

boolean

false when the request fails validation.

Example Response

{
  "Message": "Source: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Source"
    }
  ],
  "WasSuccessful": false
}

Update CheckinUpdate an existing Checkin record.

Create Checkin

curl --request POST \
  --url https://spaces.nexudus.com/api/spaces/checkins \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "BusinessId": 123,
  "FromTime": "<string>"
}
'

import requests

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

payload = {
    "BusinessId": 123,
    "FromTime": "<string>"
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({BusinessId: 123, FromTime: '<string>'})
};

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

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Enums

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400

​Authentication

​Enums

​Request Body

​Required Fields

​Optional Fields

​Code Examples

​Response

​200

​400

Authentication

Enums

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400