Skip to main content
GET
Get Current Business

Get Current Business

Returns the full details of the Nexudus location (business) that the current portal session is operating under. This is the primary bootstrap call the portal makes when the application loads. The response drives theming, feature flags, localisation, and all location-specific configuration.

Authentication

Requires a valid customer bearer token, or can return public data for unauthenticated sessions depending on location configuration.

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=Name,WebAddress,Currency.Code,TimeZone.

Response

Returns a Business object. Key fields are described below.

Identity

number
Unique numeric identifier for the location.
string
Globally unique identifier (GUID) for the location. Used in floor plan and booking requests.
string
Display name of the coworking space.
string
The subdomain identifier used in API requests (e.g. "myspace" in myspace.spaces.nexudus.com).

Localisation

object
Currency object for the location.
string
ISO 4217 currency code (e.g. "GBP", "USD", "EUR").
string
Display name of the currency (e.g. "British Pound").
string
Currency format string.
string
Default BCP 47 culture string for the location (e.g. "en-GB").
string
IANA time zone identifier for the location (e.g. "Europe/London").

Contact

string
Street address of the location.
string
City or town where the location is based.
string
Postal code of the location.
object
Country object with Id, Name, and TwoDigitsCode fields.

Portal URLs

string
Base URL of the Nexudus backend for this location (used to build authenticated redirects).
string
Base URL including the default language prefix (e.g. /en). Used for authenticated redirect links.

TypeScript Integration

Usage in Portal

Error Responses

error
Authentication is required and no valid token was supplied.
error
No location could be resolved for the current session context.