Get one BookingVisitor

GET

api

spaces

bookingvisitors

{id}

Get one BookingVisitor

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

import requests

url = "https://spaces.nexudus.com/api/spaces/bookingvisitors/{id}"

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/bookingvisitors/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "BookingId": 123,
  "VisitorId": 123,
  "VisitorFullName": "<string>",
  "VisitorEmail": "<string>",
  "VisitorPhoneNumber": "<string>",
  "VisitorCompanyName": "<string>",
  "VisitorArrivalDate": "<string>",
  "VisitorDepartureDate": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

A BookingVisitor links a Visitor to a Booking, representing a guest associated with that booking. Visitors can only be added to bookings that are associated with a customer (Booking.CoworkerId is not null). When a visitor is added to a booking, they may receive a booking confirmation email and a visitor invite email, depending on the notification settings configured for the location of the booked resource.

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 BookingVisitor-Read role.

Path Parameters

integer

required

The Id of the BookingVisitor record to retrieve.

Code Examples

curl -X GET \
  "https://spaces.nexudus.com/api/spaces/bookingvisitors/87654321" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/spaces/bookingvisitors/87654321',
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const record = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/spaces/bookingvisitors/87654321',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

record = response.json()

Response

200

integer

ID of the booking this visitor is attending. The booking determines this record’s location; the visitor email must be unique within the booking and must not match the booking customer’s email..

integer

ID of the visitor attending the selected booking. The visitor is a location-scoped record; creating or updating the link may update access-control keys for customers with the same email..

string

Display value for Visitor.FullName..

string

Display value for Visitor.Email..

string

Display value for Visitor.PhoneNumber..

string

Display value for Visitor.CompanyName..

string

Display value for Visitor.ArrivalDate..

string

Display value for Visitor.DepartureDate..

integer

Unique record identifier.

string

UUID of the record.

string

Date and time the record was created (ISO 8601).

string

Date and time the record was last updated (ISO 8601).

string

Email of the user who last updated this record.

boolean

Whether the record was recently created.

string

External system identifier.

Example Response

{
  "BookingId": 0,
  "VisitorId": 0,
  "VisitorFullName": null,
  "VisitorEmail": null,
  "VisitorPhoneNumber": null,
  "VisitorCompanyName": null,
  "VisitorArrivalDate": null,
  "VisitorDepartureDate": 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": "BookingVisitor Example",
  "LocalizationDetails": null,
  "CustomFields": null
}

Get one BookingVisitor

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

import requests

url = "https://spaces.nexudus.com/api/spaces/bookingvisitors/{id}"

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/bookingvisitors/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "BookingId": 123,
  "VisitorId": 123,
  "VisitorFullName": "<string>",
  "VisitorEmail": "<string>",
  "VisitorPhoneNumber": "<string>",
  "VisitorCompanyName": "<string>",
  "VisitorArrivalDate": "<string>",
  "VisitorDepartureDate": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Path Parameters

Code Examples

Response

200

​Authentication

​Path Parameters

​Code Examples

​Response

​200

Authentication

Path Parameters

Code Examples

Response

200