Get one BusinessDomain

GET

api

sys

businessdomains

{id}

Get one BusinessDomain

curl --request GET \
  --url https://spaces.nexudus.com/api/sys/businessdomains/{id} \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/sys/businessdomains/{id}"

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/sys/businessdomains/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "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

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"

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/businessdomains/87654321',
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const record = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/sys/businessdomains/87654321',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

record = response.json()

Response

200

integer

ID of the business linked to this record.

string

Display name for this domain mapping.

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.

boolean

Whether this domain mapping is active.

boolean

Must always be set to true.

string

Date from which this domain mapping becomes active.

string

Date after which this domain mapping is no longer active.

integer

Unique record identifier.

string

UUID of the record.

string

Date and time the record was created (ISO 8601).

string

Date and time the record was last updated (ISO 8601).

string

Email of the user who last updated this record.

boolean

Whether the record was recently created.

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
}

Get multiple BusinessDomainsRetrieve multiple BusinessDomain records by their Ids in a single request.

Get one BusinessDomain

curl --request GET \
  --url https://spaces.nexudus.com/api/sys/businessdomains/{id} \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/sys/businessdomains/{id}"

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/sys/businessdomains/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "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>"
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Path Parameters

Code Examples

Response

200

​Authentication

​Path Parameters

​Code Examples

​Response

​200

Authentication

Path Parameters

Code Examples

Response

200