Search Visitors

GET

api

spaces

visitors

Search Visitors

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

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

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

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

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-List role.

Enums

eVisitorSource — VisitorSource values

Value	Name
1	Administrator
2	NexIO
3	Customer

eVisitorHostApprovalStatus — HostApprovalStatus values

Value	Name
1	NotRequired
2	Requested
3	Rejected
4	AcceptedAndHold
5	AcceptedAndGrant

Query Parameters

Pagination & Sorting

integer

default:"1"

The page number to retrieve.

integer

default:"25"

The number of records per page.

string

The property name to sort results by (e.g. Name, CreatedOn).

integer

Sort direction. 0 for ascending, 1 for descending.

Filters

integer

Filter by iD of the location this visitor is visiting; required..

string

Filter by visitor’s full name; required..

string

Filter by visitor’s email address; required and validated as an email address..

integer

Filter by iD of the customer hosting this visitor; required..

string

Filter by display value for Coworker.CoworkerType..

string

Filter by display value for Coworker.FullName..

string

Filter by display value for Coworker.CompanyName..

string

Filter by display value for Coworker.BillingName..

string

Filter by display value for Coworker.Email..

string

Filter by display value for Coworker.TeamNames..

integer

Filter by 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..

integer

Filter by host approval workflow state: NotRequired, Requested, Rejected, AcceptedAndHold, or AcceptedAndGrant; manage pending approvals with the dedicated visitor approval tool..

string

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

string

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

string

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

string

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

string

Filter by optional reason the visitor is coming to the location..

string

Filter by optional company or organization the visitor represents..

string

Filter by optional phone number for contacting the visitor..

string

Filter by expected arrival date and time, stored in UTC and required when creating a visitor..

boolean

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

string

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

string

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

boolean

Filter by internal notification state set after the visitor has checked in..

boolean

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

boolean

Filter by 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

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

boolean

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

string

Filter by internal identifier for the access-control scheduling job associated with this visitor..

boolean

Filter by 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

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

Range Filters

string

Filter by expected arrival date and time, stored in UTC and required when creating a visitor. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by expected arrival date and time, stored in UTC and required when creating a visitor. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by uTC timestamp when the visitor checked in, maintained by the check-in workflow. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by uTC timestamp when the visitor checked in, maintained by the check-in workflow. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by uTC timestamp when the visitor checked out, maintained by the check-out workflow. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by uTC timestamp when the visitor checked out, maintained by the check-out workflow. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter records created on or after this date. Format: YYYY-MM-DDTHH:mm.

string

Filter records created on or before this date. Format: YYYY-MM-DDTHH:mm.

string

Filter records updated on or after this date. Format: YYYY-MM-DDTHH:mm.

string

Filter records updated on or before this date. Format: YYYY-MM-DDTHH:mm.

Code Examples

Simple listing

curl -X GET \
  "https://spaces.nexudus.com/api/spaces/visitors?page=1&size=15&orderBy=FullName&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/spaces/visitors?' + new URLSearchParams({
    page: 1,
    size: 15,
    orderBy: 'FullName',
    dir: 1 // Ascending
  }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/spaces/visitors',
    params={
        'page': 1,
        'size': 15,
        'orderBy': 'FullName',
        'dir': 0 // Ascending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Filtering by FullName

curl -X GET \
  "https://spaces.nexudus.com/api/spaces/visitors?Visitor_FullName=example-value&orderBy=FullName&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/spaces/visitors?' + new URLSearchParams({
    Visitor_FullName: 'example-value',
    orderBy: 'FullName',
    dir: 1
  }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/spaces/visitors',
    params={
        'Visitor_FullName': 'example-value',
        'orderBy': 'FullName',
        'dir': 0 // Ascending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Range filters

curl -X GET \
  "https://spaces.nexudus.com/api/spaces/visitors?from_Visitor_UpdatedOn=2025-01-01T00:00&to_Visitor_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/spaces/visitors?' + new URLSearchParams({
    from_Visitor_UpdatedOn: '2025-01-01T00:00',
    to_Visitor_UpdatedOn: '2025-12-31T23:59',
    orderBy: 'UpdatedOn',
    dir: 1 // Descending
   }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/spaces/visitors',
    params={
        'from_Visitor_UpdatedOn': '2025-01-01T00:00',
        'to_Visitor_UpdatedOn': '2025-12-31T23:59',
        'orderBy': 'UpdatedOn',
        'dir': 1 // Descending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Response

200

Visitor[]

The list of Visitor records matching the query. See the Get one Visitor endpoint for the full list of properties returned for each record.

Partial records — The listing endpoint returns a summary representation of each Visitor. The following fields are not populated in the Records[] response: Notes, CheckInNow.To get all fields, fetch the full record using the Get one Visitor endpoint.Important for updates: When updating a record via PUT, always retrieve the full record with a GET request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a PUT request, as missing fields may be unintentionally cleared.

integer

Current page number.

integer

Number of records per page.

string

The field used for sorting.

integer

The sort direction (0 = ascending, 1 = descending).

integer

Index of the first item on the current page.

integer

Index of the last item on the current page.

integer

Total number of matching records across all pages.

integer

Total number of pages.

boolean

Whether there is a next page of results.

boolean

Whether there is a previous page of results.

Example Response

{
  "Records": [
    {
      "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,
      "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,
      "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
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "FullName",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}

Search Visitors

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

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

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

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Enums

Query Parameters

Filters

Range Filters

Code Examples

Simple listing

Filtering by FullName

Range filters

Response

200

​Authentication

​Enums

​Query Parameters

​Pagination & Sorting

​Filters

​Range Filters

​Code Examples

​Simple listing

​Filtering by FullName

​Range filters

​Response

​200

Authentication

Enums

Query Parameters

Pagination & Sorting

Filters

Range Filters

Code Examples

Simple listing

Filtering by FullName

Range filters

Response

200