Skip to main content
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>'
{
  "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

​
id
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"

​
Response

​
200

​
BusinessId
integer
ID of the business linked to this record.
​
FullName
string
Visitor full name.
​
Email
string
Visitor email.
​
CoworkerId
integer
ID of the coworker linked to this record.
​
CoworkerCoworkerType
string
Host coworker type.
​
CoworkerFullName
string
Host coworker full name.
​
CoworkerCompanyName
string
Host coworker company name.
​
CoworkerBillingName
string
Host coworker billing name.
​
CoworkerEmail
string
Host coworker email.
​
CoworkerTeamNames
string
Host coworker team names.
​
VisitorSource
integer
Visitor source. See eVisitorSource enum values: 1 = Administrator, 2 = NexIO, 3 = Customer.
​
HostApprovalStatus
integer
Host approval status. See eVisitorHostApprovalStatus enum values: 1 = NotRequired, 2 = Requested, 3 = Rejected, 4 = AcceptedAndHold, 5 = AcceptedAndGrant.
​
VisitorCode
string
Visitor code.
​
CheckedInAt
string
Location checked in at.
​
Notes
string
Optional notes or comments about this visitor.
​
CustomerNotes
string
Customer notes.
​
VisitReason
string
Reason for visit.
​
CompanyName
string
Visitor company name.
​
PhoneNumber
string
Visitor phone number.
​
ExpectedArrival
string
Expected arrival date and time.
​
Arrived
boolean
Whether the visitor has arrived.
​
ArrivalDate
string
Actual arrival date.
​
DepartureDate
string
Departure date.
​
Notified
boolean
Whether notified is enabled.
​
Internal
boolean
Whether internal is enabled.
​
IsTour
boolean
Whether this is a tour visit.
​
HasAgreedTerms
boolean
Whether the visitor has agreed to terms.
​
TourConfirmed
boolean
Whether the tour is confirmed.
​
AccessControlScheduledJobId
string
ID of the access control scheduled job associated with this record.
​
CheckInNow
boolean
Check in the visitor now.
​
Id
integer
Unique record identifier.
​
UniqueId
string
UUID of the record.
​
CreatedOn
string
Date and time the record was created (ISO 8601).
​
UpdatedOn
string
Date and time the record was last updated (ISO 8601).
​
UpdatedBy
string
Email of the user who last updated this record.
​
IsNew
boolean
Whether the record was recently created.
​
SystemId
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
}