Skip to main content
GET
/
api
/
public
/
visitors
/
my
List Visitors
curl --request GET \
  --url https://spaces.nexudus.com/api/public/visitors/my \
  --header 'Authorization: Basic <encoded-value>'

Documentation Index

Fetch the complete documentation index at: https://learn.nexudus.com/llms.txt

Use this file to discover all available pages before exploring further.

​
List Visitors

Returns the list of visitors registered by the authenticated customer. Optionally filter to only upcoming visits.

​
Authentication

Requires a valid customer bearer token.

​
Query Parameters

​
showUpcoming
boolean
true — return only future visits. false or omitted — return all visitors.
​
_shape
string
Comma-separated list of field paths to include in the response. When provided, only the specified fields are returned — useful for reducing payload size. Supports nested paths using dot notation. Example: _shape=Records.FullName,Records.ExpectedArrival,Records.Arrived.

​
Response

Returns a VisitorList object containing an array of visitor records.

​
Visitor Fields

​
Identity

FieldTypeDescription
IdnumberUnique numeric identifier for the visitor
UniqueIdstringGlobally unique identifier

​
Core

FieldTypeDescription
FullNamestringVisitor’s full name
EmailstringVisitor’s email address
PhoneNumberstringVisitor’s phone number
Notesstring | nullCustomer notes about the visit

​
Schedule

FieldTypeDescription
ExpectedArrivalstring | nullExpected arrival (business-local time)
UtcExpectedArrivalstring | nullExpected arrival (UTC)
ArrivalDatestring | nullActual arrival date (business-local)
UtcArrivalDatestring | nullActual arrival date (UTC)
ArrivedbooleanWhether the visitor has arrived

​
Media

FieldTypeDescription
GravatarHashedEmailstring | nullMD5-hashed email for Gravatar lookups
DefaultAvatarUrlstring | nullGenerated avatar URL from initials

​
Timestamps (from base)

FieldTypeDescription
CreatedOnstringDate created (business-local time)
UpdatedOnstring | nullDate last updated (business-local time)
CreatedOnUtcstringDate created (UTC)
UpdatedOnUtcstring | nullDate last updated (UTC)

​
Examples

​
Fetch upcoming visitors

GET /api/public/visitors/my?showUpcoming=true
Authorization: Bearer {token}

​
TypeScript Integration

import endpoints from '@/api/endpoints'

const { resource: visitors } = useTypedData(httpClient, endpoints.visitors.list(true))