GET

api

public

businesses

withTour

List Businesses with Tour

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

import requests

url = "https://spaces.nexudus.com/api/public/businesses/withTour"

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/public/businesses/withTour', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Businesses": [
    {}
  ],
  "Businesses[].Id": 123,
  "Businesses[].UniqueId": "<string>",
  "Businesses[].Name": "<string>",
  "Businesses[].WebAddress": "<string>",
  "401 Unauthorized": {}
}

List Businesses with Tour

Returns all locations in the network where the space tour feature is active. The portal uses this to determine which locations a prospective member can book a tour at, and to build location pickers in the tour booking flow.

Authentication

Requires a valid customer bearer token.

Query Parameters

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=Businesses.Name,Businesses.WebAddress.

Response

array

Array of location objects for locations that have the tour feature enabled.

number

Unique numeric identifier for the location.

string

Globally unique identifier (GUID) for the location.

string

Display name of the location.

string

Subdomain identifier for the location (e.g. "myspace").

Example Response

{
  "Businesses": [
    {
      "Id": 1,
      "UniqueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "Name": "Main Location",
      "WebAddress": "mainlocation"
    }
  ]
}

TypeScript Integration

import endpoints from '@/api/endpoints'
import { useTypedData } from '@/api/fetchData'
import { AllLocations } from '@/types/AllLocations'

const endpoint = endpoints.system.business.withTour()
// endpoint.type is { Businesses: AllLocations[] }

const { resource } = useTypedData(httpClient, endpoint)
const tourLocations = resource?.Businesses ?? []

Usage in Portal

Context	Source file
Space tour booking location picker	`src/views/tours/` or checkout flow

Error Responses

error

The bearer token is missing, expired, or invalid.

Method	Endpoint	Description
`GET`	`/api/public/businesses/current`	Get the current location
`GET`	`/api/public/businesses/all`	List all locations in the network
`GET`	`/api/public/businesses/withVisitors`	List locations with visitor registration

Get Portal ConfigurationRetrieve the full portal feature configuration for the current Nexudus location.

List Businesses with Tour

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

import requests

url = "https://spaces.nexudus.com/api/public/businesses/withTour"

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/public/businesses/withTour', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Businesses": [
    {}
  ],
  "Businesses[].Id": 123,
  "Businesses[].UniqueId": "<string>",
  "Businesses[].Name": "<string>",
  "Businesses[].WebAddress": "<string>",
  "401 Unauthorized": {}
}

​List Businesses with Tour

​Authentication

​Query Parameters

​Response

​Example Response

​TypeScript Integration

​Usage in Portal

​Error Responses

​Related Endpoints

List Businesses with Tour

Authentication

Query Parameters

Response

Example Response

TypeScript Integration

Usage in Portal

Error Responses

Related Endpoints