Skip to main content
GET
/
api
/
sys
/
businessdomains
/
{id}
{
  "BusinessId": 123,
  "Name": "<string>",
  "DomainURL": "<string>",
  "Active": true,
  "SslProxy": true,
  "ActiveFrom": "<string>",
  "ActiveTo": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}
A BusinessDomain represents a custom domain or subdomain configured for a location’s Members Portal. By default each location gets a <name>.spaces.nexudus.com address. A BusinessDomain lets you replace that with your own domain (e.g. coworking.com) or subdomain (e.g. london.coworking.com).
  • For custom domains, an SSL proxy (e.g. CloudFlare) must be configured and SslProxy must be set to true.
  • For custom subdomains, a CNAME record pointing to Nexudus is required. SslProxy must still be set to true.
Use ActiveFrom and ActiveTo to schedule when the domain mapping takes effect. Changes typically propagate within two to three days.

​
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 BusinessDomain-Read role.

​
Path Parameters

​
id
integer
required
The Id of the BusinessDomain record to retrieve.

​
Code Examples

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

​
Response

​
200

​
BusinessId
integer
Business Id.
​
Name
string
Display name for this domain mapping.
​
DomainURL
string
The custom domain or subdomain hostname — despite the name, this is just the bare domain (e.g. coworking.com or london.coworking.com), without https:// or any path.
​
Active
boolean
Whether this domain mapping is active.
​
SslProxy
boolean
Must always be set to true.
​
ActiveFrom
string
Date from which this domain mapping becomes active.
​
ActiveTo
string
Date after which this domain mapping is no longer active.
​
Id
integer
Unique record identifier.
​
UniqueId
string
UUID of the record.
​
CreatedOn
string
Date and time the record was created (ISO 8601).
​
UpdatedOn
string
Date and time the record was last updated (ISO 8601).
​
UpdatedBy
string
Email of the user who last updated this record.
​
IsNew
boolean
Whether the record was recently created.
​
SystemId
string
External system identifier.
Example Response
{
  "BusinessId": 0,
  "Name": "",
  "DomainURL": "",
  "Active": false,
  "SslProxy": false,
  "ActiveFrom": null,
  "ActiveTo": 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": "BusinessDomain Example",
  "LocalizationDetails": null,
  "CustomFields": null
}