Search Visitors - Nexudus Platform

GET

api

spaces

visitors

Search Visitors

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

{
  "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

page

integer

default:"1"

The page number to retrieve.

size

integer

default:"25"

The number of records per page.

orderBy

string

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

dir

integer

Sort direction. 0 for ascending, 1 for descending.

Filters

Visitor_Business

integer

Filter by iD of the business linked to this record.

Visitor_FullName

string

Filter by visitor full name.

Visitor_Email

string

Filter by visitor email.

Visitor_Coworker

integer

Filter by iD of the coworker linked to this record.

Visitor_Coworker_CoworkerType

string

Filter by host coworker type.

Visitor_Coworker_FullName

string

Filter by host coworker full name.

Visitor_Coworker_CompanyName

string

Filter by host coworker company name.

Visitor_Coworker_BillingName

string

Filter by host coworker billing name.

Visitor_Coworker_Email

string

Filter by host coworker email.

Visitor_Coworker_TeamNames

string

Filter by host coworker team names.

Visitor_VisitorSource

integer

Filter by visitor source.

Visitor_HostApprovalStatus

integer

Filter by host approval status.

Visitor_VisitorCode

string

Filter by visitor code.

Visitor_CheckedInAt

string

Filter by location checked in at.

Visitor_Notes

string

Filter by optional notes or comments about this visitor.

Visitor_CustomerNotes

string

Filter by customer notes.

Visitor_VisitReason

string

Filter by reason for visit.

Visitor_CompanyName

string

Filter by visitor company name.

Visitor_PhoneNumber

string

Filter by visitor phone number.

Visitor_ExpectedArrival

string

Filter by expected arrival date and time.

Visitor_Arrived

boolean

Filter by whether the visitor has arrived.

Visitor_ArrivalDate

string

Filter by actual arrival date.

Visitor_DepartureDate

string

Filter by departure date.

Visitor_Notified

boolean

Filter by whether notified is enabled.

Visitor_Internal

boolean

Filter by whether internal is enabled.

Visitor_IsTour

boolean

Filter by whether this is a tour visit.

Visitor_HasAgreedTerms

boolean

Filter by whether the visitor has agreed to terms.

Visitor_TourConfirmed

boolean

Filter by whether the tour is confirmed.

Visitor_AccessControlScheduledJobId

string

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

Visitor_CheckInNow

boolean

Filter by check in the visitor now.

Range Filters

from_Visitor_ExpectedArrival

string

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

to_Visitor_ExpectedArrival

string

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

from_Visitor_ArrivalDate

string

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

to_Visitor_ArrivalDate

string

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

from_Visitor_DepartureDate

string

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

to_Visitor_DepartureDate

string

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

from_Visitor_CreatedOn

string

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

to_Visitor_CreatedOn

string

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

from_Visitor_UpdatedOn

string

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

to_Visitor_UpdatedOn

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"

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"

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"

Response

200

Records

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.

CurrentPage

integer

Current page number.

CurrentPageSize

integer

Number of records per page.

CurrentOrderField

string

The field used for sorting.

CurrentSortDirection

integer

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

FirstItem

integer

Index of the first item on the current page.

LastItem

integer

Index of the last item on the current page.

TotalItems

integer

Total number of matching records across all pages.

TotalPages

integer

Total number of pages.

HasNextPage

boolean

Whether there is a next page of results.

HasPreviousPage

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

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

​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