List All Businesses
Returns all locations (businesses) within the Nexudus network, optionally including the root organisation entry and locations that have been hidden from public views. Used by multi-location portals to build location pickers and network-wide navigation.
Authentication
Requires a valid customer bearer token.
Query Parameters
When true, the root organisation entry is included in the response alongside individual locations.
When true, locations that have been marked as hidden (not publicly listed) are included in the results.
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=Name,WebAddress,Address,TownCity.
Response
Returns an array of location objects. Each entry follows the same shape as the GET /api/public/businesses/current response.
Business Fields
Identity
| Field | Type | Description |
|---|
Id | number | Unique numeric identifier for the location |
UniqueId | string | Globally unique identifier |
Core
| Field | Type | Description |
|---|
Name | string | Display name of the coworking space |
WebAddress | string | Subdomain identifier (e.g. "myspace") |
Address | string | Street address |
TownCity | string | Town or city |
State | string | State or province |
Phone | string | Phone number |
Fax | string | Fax number |
EmailContact | string | Contact email address |
WebContact | string | Contact website URL |
Quote | string | Location tagline / quote |
AboutUs | string | About Us text |
ShortIntroduction | string | Short intro text |
Localisation
| Field | Type | Description |
|---|
Country | object | Country object (Id, Name, TwoDigitsCode) |
Currency | object | Currency object (Code, Name, Format) |
SimpleTimeZone | object | Timezone object |
Location
| Field | Type | Description |
|---|
Longitude | number | null | Longitude coordinate |
Latitude | number | null | Latitude coordinate |
Branding
| Field | Type | Description |
|---|
HasLogo | boolean | Whether location has a logo |
HasBanner | boolean | Whether location has a banner |
CurrentThemeName | string | Active theme name |
Policies
| Field | Type | Description |
|---|
CookiePolicyUrl | string | Cookie policy URL |
PrivacyPolicyUrl | string | Privacy policy URL |
TermsAndConditions | string | Terms and conditions |
Network
| Field | Type | Description |
|---|
IsChildLocation | boolean | Whether this is a child location |
RootBusinessId | number | null | Parent location identifier |
Businesses | object[] | Child locations (if any) |
Timestamps (from base)
| Field | Type | Description |
|---|
CreatedOn | string | Date created (business-local time) |
UpdatedOn | string | null | Date last updated (business-local time) |
CreatedOnUtc | string | Date created (UTC) |
UpdatedOnUtc | string | null | Date last updated (UTC) |
## TypeScript Integration
```typescript
import endpoints from '@/api/endpoints'
const url = endpoints.system.business.businesses(false, false)
// => '/api/public/businesses/all?includeRoot=false&includeHidden=false'
const response = await httpClient.get(url)
Usage in Portal
| Context | Source file |
|---|
| Multi-location switcher / network picker | src/components/LocationSwitcher/ |
| Passport / map view | src/views/passport/ |
Error Responses
The bearer token is missing, expired, or invalid.
| Method | Endpoint | Description |
|---|
GET | /api/public/businesses/current | Get the current location |
GET | /api/public/businesses/withVisitors | Get locations with visitor registration enabled |
GET | /api/public/businesses/withTour | Get locations that offer space tours |
