Skip to main content
GET
/
api
/
public
/
businesses
/
withVisitors
{
  "Businesses": [
    {}
  ],
  "Businesses[].Id": 123,
  "Businesses[].UniqueId": "<string>",
  "Businesses[].Name": "<string>",
  "Businesses[].WebAddress": "<string>",
  "401 Unauthorized": {}
}

​
List Businesses with Visitor Registration

Returns all locations in the network where the visitor registration feature is active. The portal uses this to determine which locations a member can register a visitor for, and to build location pickers in the visitor registration flow.

​
Authentication

Requires a valid customer bearer token.

​
Query Parameters

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

​
Response

​
Businesses
array
Array of location objects for locations that have visitor registration enabled.
​
Businesses[].Id
number
Unique numeric identifier for the location.
​
Businesses[].UniqueId
string
Globally unique identifier (GUID) for the location.
​
Businesses[].Name
string
Display name of the location.
​
Businesses[].WebAddress
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.withVisitors()
// endpoint.type is { Businesses: AllLocations[] }

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

​
Usage in Portal

ContextSource file
Visitor registration location pickersrc/views/visitors/

​
Error Responses

​
401 Unauthorized
error
The bearer token is missing, expired, or invalid.
MethodEndpointDescription
GET/api/public/businesses/currentGet the current location
GET/api/public/businesses/allList all locations in the network
GET/api/public/businesses/withTourList locations offering space tours
GETapi/public/visitors/myList the current customer’s registered visitors