Skip to main content
GET
/
api
/
sys
/
businessdomains
{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}
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-List role.

​
Query Parameters

​
Pagination & Sorting

​
page
integer
default:"1"
The page number to retrieve.
​
size
integer
default:"25"
The number of records per page.
​
orderBy
string
The property name to sort results by (e.g. Name, CreatedOn).
​
dir
integer
Sort direction. 1 for ascending, -1 for descending.

​
Filters

​
BusinessDomain_Business
integer
Filter by Business Id.
​
BusinessDomain_Name
string
Filter by display name for this domain mapping.
​
BusinessDomain_DomainURL
string
Filter by 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.
​
BusinessDomain_Active
boolean
Filter by whether this domain mapping is active.
​
BusinessDomain_SslProxy
boolean
Filter by must always be set to true.
​
BusinessDomain_ActiveFrom
string
Filter by date from which this domain mapping becomes active.
​
BusinessDomain_ActiveTo
string
Filter by date after which this domain mapping is no longer active.

​
Range Filters

​
from_BusinessDomain_ActiveFrom
string
Filter by date from which this domain mapping becomes active greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
​
to_BusinessDomain_ActiveFrom
string
Filter by date from which this domain mapping becomes active less than or equal to this value. Format: YYYY-MM-DDTHH:mm.
​
from_BusinessDomain_ActiveTo
string
Filter by date after which this domain mapping is no longer active greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
​
to_BusinessDomain_ActiveTo
string
Filter by date after which this domain mapping is no longer active less than or equal to this value. Format: YYYY-MM-DDTHH:mm.
​
from_BusinessDomain_CreatedOn
string
Filter records created on or after this date. Format: YYYY-MM-DDTHH:mm.
​
to_BusinessDomain_CreatedOn
string
Filter records created on or before this date. Format: YYYY-MM-DDTHH:mm.
​
from_BusinessDomain_UpdatedOn
string
Filter records updated on or after this date. Format: YYYY-MM-DDTHH:mm.
​
to_BusinessDomain_UpdatedOn
string
Filter records updated on or before this date. Format: YYYY-MM-DDTHH:mm.

​
Code Examples

​
Simple listing

curl -X GET \
  "https://spaces.nexudus.com/api/sys/businessdomains?page=1&size=15&orderBy=Name&dir=1" \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Filtering by Name

curl -X GET \
  "https://spaces.nexudus.com/api/sys/businessdomains?BusinessDomain_Name=example-value&orderBy=Name&dir=1" \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Range filters

curl -X GET \
  "https://spaces.nexudus.com/api/sys/businessdomains?from_BusinessDomain_UpdatedOn=2025-01-01T00:00&to_BusinessDomain_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=-1" \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Response

​
200

​
Records
BusinessDomain[]
The list of BusinessDomain records matching the query. See the Get one BusinessDomain endpoint for the full list of properties returned for each record.
​
CurrentPage
integer
Current page number.
​
CurrentPageSize
integer
Number of records per page.
​
CurrentOrderField
string
The field used for sorting.
​
CurrentSortDirection
integer
The sort direction (1 = ascending, -1 = descending).
​
FirstItem
integer
Index of the first item on the current page.
​
LastItem
integer
Index of the last item on the current page.
​
TotalItems
integer
Total number of matching records across all pages.
​
TotalPages
integer
Total number of pages.
​
HasNextPage
boolean
Whether there is a next page of results.
​
HasPreviousPage
boolean
Whether there is a previous page of results.
Example Response
{
  "Records": [
    {
      "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
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "Name",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}