Get one Visitor

GET

api

spaces

visitors

{id}

Get one Visitor

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

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

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

{
  "BusinessId": 123,
  "FullName": "<string>",
  "Email": "<string>",
  "CoworkerId": 123,
  "CoworkerCoworkerType": "<string>",
  "CoworkerFullName": "<string>",
  "CoworkerCompanyName": "<string>",
  "CoworkerBillingName": "<string>",
  "CoworkerEmail": "<string>",
  "CoworkerTeamNames": "<string>",
  "VisitorSource": 123,
  "HostApprovalStatus": 123,
  "VisitorCode": "<string>",
  "CheckedInAt": "<string>",
  "Notes": "<string>",
  "CustomerNotes": "<string>",
  "VisitReason": "<string>",
  "CompanyName": "<string>",
  "PhoneNumber": "<string>",
  "ExpectedArrival": "<string>",
  "Arrived": true,
  "ArrivalDate": "<string>",
  "DepartureDate": "<string>",
  "Notified": true,
  "Internal": true,
  "IsTour": true,
  "HasAgreedTerms": true,
  "TourConfirmed": true,
  "AccessControlScheduledJobId": "<string>",
  "CheckInNow": true,
  "IsCustomer": true,
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

A Visitor is a guest expected at a location, optionally hosted by a customer. Visitors can be registered by an administrator or Admin Agent, from the customer portal, app, AI assistant, or NexIO reception tablet, as guests on a booking, or as public tour requests; the record tracks contact details, arrival, tours, and host approval.

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

Path Parameters

integer

required

The Id of the Visitor record to retrieve.

Code Examples

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

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

const record = await response.json();

import requests

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

record = response.json()

Response

200

integer

ID of the location this visitor is visiting; required..

string

Visitor’s full name; required..

string

Visitor’s email address; required and validated as an email address..

integer

ID of the customer hosting this visitor; required..

string

Display value for Coworker.CoworkerType..

string

Display value for Coworker.FullName..

string

Display value for Coworker.CompanyName..

string

Display value for Coworker.BillingName..

string

Display value for Coworker.Email..

string

Display value for Coworker.TeamNames..

integer

How the visitor was registered: Administrator for staff and Admin Agent registrations, Customer for registrations from the customer portal, app, or AI assistant, or NexIO for the reception tablet app; booking guests are synchronized from their booking.. See eVisitorSource enum values: 1 = Administrator, 2 = NexIO, 3 = Customer.

integer

Host approval workflow state: NotRequired, Requested, Rejected, AcceptedAndHold, or AcceptedAndGrant; manage pending approvals with the dedicated visitor approval tool.. See eVisitorHostApprovalStatus enum values: 1 = NotRequired, 2 = Requested, 3 = Rejected, 4 = AcceptedAndHold, 5 = AcceptedAndGrant.

string

System-generated visitor access code, created for eligible upcoming visits and used to locate the visitor at the location..

string

Check-in location/value; use Arrived, ArrivalDate, and DepartureDate for the visitor’s current visit status..

string

Optional internal staff notes about the visitor, limited to 1,024 characters and not shown to the visitor..

string

Optional notes supplied by the hosting customer, limited to 1,024 characters; read-only for administrators..

string

Optional reason the visitor is coming to the location..

string

Optional company or organization the visitor represents..

string

Optional phone number for contacting the visitor..

string

Expected arrival date and time, stored in UTC and required when creating a visitor..

boolean

Whether the visitor is currently checked in; maintained by the visitor check-in and check-out workflow..

string

UTC timestamp when the visitor checked in, maintained by the check-in workflow..

string

UTC timestamp when the visitor checked out, maintained by the check-out workflow..

boolean

Internal notification state set after the visitor has checked in..

boolean

Internal booking-visitor classification set when the visitor matches a customer and the location excludes known customers from visitor registration..

boolean

Whether this visit is a tour; tour requests from the public portal or AI assistant create tour visitors, which require a hosting customer and use the tour confirmation workflow..

boolean

Whether the visitor has accepted the applicable terms; maintained by the visitor-facing legal flow..

boolean

Whether a tour visit has been confirmed; maintained by the dedicated tour confirmation workflow and set automatically on check-in..

string

Internal identifier for the access-control scheduling job associated with this visitor..

boolean

Whether to check the visitor in immediately when creating the record; also sets ArrivalDate to the current UTC time and clears any departure time..

boolean

Internal flag set for booking visitors whose email already belongs to a customer at the location..

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

{
  "BusinessId": 0,
  "FullName": "",
  "Email": "",
  "CoworkerId": null,
  "CoworkerCoworkerType": null,
  "CoworkerFullName": null,
  "CoworkerCompanyName": null,
  "CoworkerBillingName": null,
  "CoworkerEmail": null,
  "CoworkerTeamNames": null,
  "VisitorSource": 0,
  "HostApprovalStatus": 0,
  "VisitorCode": null,
  "CheckedInAt": null,
  "Notes": null,
  "CustomerNotes": null,
  "VisitReason": null,
  "CompanyName": null,
  "PhoneNumber": null,
  "ExpectedArrival": null,
  "Arrived": false,
  "ArrivalDate": null,
  "DepartureDate": null,
  "Notified": false,
  "Internal": false,
  "IsTour": false,
  "HasAgreedTerms": false,
  "TourConfirmed": false,
  "AccessControlScheduledJobId": null,
  "CheckInNow": false,
  "IsCustomer": false,
  "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": "Visitor Example",
  "LocalizationDetails": null,
  "CustomFields": null
}

Get one Visitor

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

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

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

{
  "BusinessId": 123,
  "FullName": "<string>",
  "Email": "<string>",
  "CoworkerId": 123,
  "CoworkerCoworkerType": "<string>",
  "CoworkerFullName": "<string>",
  "CoworkerCompanyName": "<string>",
  "CoworkerBillingName": "<string>",
  "CoworkerEmail": "<string>",
  "CoworkerTeamNames": "<string>",
  "VisitorSource": 123,
  "HostApprovalStatus": 123,
  "VisitorCode": "<string>",
  "CheckedInAt": "<string>",
  "Notes": "<string>",
  "CustomerNotes": "<string>",
  "VisitReason": "<string>",
  "CompanyName": "<string>",
  "PhoneNumber": "<string>",
  "ExpectedArrival": "<string>",
  "Arrived": true,
  "ArrivalDate": "<string>",
  "DepartureDate": "<string>",
  "Notified": true,
  "Internal": true,
  "IsTour": true,
  "HasAgreedTerms": true,
  "TourConfirmed": true,
  "AccessControlScheduledJobId": "<string>",
  "CheckInNow": true,
  "IsCustomer": true,
  "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