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

import requests

url = "https://spaces.nexudus.com/api/spaces/visitors/{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/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,
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

A Visitor represents a person visiting a location who is not a member. Visitors are registered with their name, contact details, expected arrival time, and the host (customer) they are visiting. Visitor management includes check-in/check-out tracking and optional host approval workflows.

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 business linked to this record.

string

Visitor full name.

string

Visitor email.

integer

ID of the coworker linked to this record.

string

Host coworker type.

string

Host coworker full name.

string

Host coworker company name.

string

Host coworker billing name.

string

Host coworker email.

string

Host coworker team names.

integer

Visitor source. See eVisitorSource enum values: 1 = Administrator, 2 = NexIO, 3 = Customer.

integer

Host approval status. See eVisitorHostApprovalStatus enum values: 1 = NotRequired, 2 = Requested, 3 = Rejected, 4 = AcceptedAndHold, 5 = AcceptedAndGrant.

string

Visitor code.

string

Location checked in at.

string

Optional notes or comments about this visitor.

string

Customer notes.

string

Reason for visit.

string

Visitor company name.

string

Visitor phone number.

string

Expected arrival date and time.

boolean

Whether the visitor has arrived.

string

Actual arrival date.

string

Departure date.

boolean

Whether notified is enabled.

boolean

Whether internal is enabled.

boolean

Whether this is a tour visit.

boolean

Whether the visitor has agreed to terms.

boolean

Whether the tour is confirmed.

string

ID of the access control scheduled job associated with this record.

boolean

Check in the visitor now.

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,
  "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 multiple VisitorsRetrieve multiple Visitor records by their Ids in a single request.

Get one Visitor

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

import requests

url = "https://spaces.nexudus.com/api/spaces/visitors/{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/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,
  "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