Search Visitors

GET

api

spaces

visitors

Search Visitors

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

import requests

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

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

string

Filter by visitor full name.

string

Filter by visitor email.

integer

Filter by iD of the coworker linked to this record.

string

Filter by host coworker type.

string

Filter by host coworker full name.

string

Filter by host coworker company name.

string

Filter by host coworker billing name.

string

Filter by host coworker email.

string

Filter by host coworker team names.

integer

Filter by visitor source.

integer

Filter by host approval status.

string

Filter by visitor code.

string

Filter by location checked in at.

string

Filter by optional notes or comments about this visitor.

string

Filter by customer notes.

string

Filter by reason for visit.

string

Filter by visitor company name.

string

Filter by visitor phone number.

string

Filter by expected arrival date and time.

boolean

Filter by whether the visitor has arrived.

string

Filter by actual arrival date.

string

Filter by departure date.

boolean

Filter by whether notified is enabled.

boolean

Filter by whether internal is enabled.

boolean

Filter by whether this is a tour visit.

boolean

Filter by whether the visitor has agreed to terms.

boolean

Filter by whether the tour is confirmed.

string

Filter by iD of the access control scheduled job associated with this record.

boolean

Filter by check in the visitor now.

Range Filters

string

Filter by expected arrival date and time greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by expected arrival date and time less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by actual arrival date greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by actual arrival date less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by departure date greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by departure date 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: VisitorSource, HostApprovalStatus, CheckedInAt, Notes, CustomerNotes, ArrivalDate, DepartureDate, 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,
      "VisitorCode": null,
      "VisitReason": null,
      "CompanyName": null,
      "PhoneNumber": null,
      "ExpectedArrival": null,
      "Arrived": false,
      "Notified": false,
      "Internal": false,
      "IsTour": false,
      "HasAgreedTerms": false,
      "TourConfirmed": false,
      "AccessControlScheduledJobId": null,
      "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
}

Get one VisitorRetrieve a single Visitor record by its Id.

Search Visitors

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

import requests

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

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