Search Businesses

GET

api

sys

businesses

Search Businesses

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

import requests

url = "https://spaces.nexudus.com/api/sys/businesses"

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

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

A Business represents an individual location or a group of locations in Nexudus. Most records in the system are connected — directly or via other records — to a business, which controls access and visibility based on the locations a user or customer can access. Businesses can be organised into a hierarchy using RootLocationId, which references the parent business of a given business. A business with no RootLocationId is a top-level location. Child businesses inherit certain configuration from their parent. Each business defines its own address, contact details, currency, opening hours, and public-facing content (Passport profile, website text, branding images). Read-only properties such as opening hours, theme, and image URLs reflect the current configuration set through the Nexudus admin UI.

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 Business-List role.

Enums

eHelpItemFlag — VisitedHelpItems values

Value	Name
0	None
1	WelcomePage
2	GridPage
4	EditPage
8	SettingsPage
16	HelpPage

eLanguage — DefaultLanguage values

Value	Name
3	EnglishUK
1	EnglishUS
2	Spanish

eVenueType — VenueType values

Value	Name
1	BusinessCenter
2	CorporateOffice
3	CoworkingSpace
4	Hotel
5	InformalOffice
6	Studio
7	Other

eFloorUnit — FloorSpaceUnit values

Value	Name
1	SqFt
2	SqMt

ePassportAccess — PassportMembersAccess values

Value	Name
1	Everyone
2	RegisteredUsers
3	RegisteredWithMySpaceUsers
4	NoOne

Query Parameters

Pagination & Sorting

integer

default:"1"

The page number to retrieve.

integer

default:"25"

The number of records per page.

string

The property name to sort results by (e.g. Name, CreatedOn).

integer

Sort direction. 0 for ascending, 1 for descending.

Filters

integer

Filter by the visited help items value for this business.

string

Filter by display name of the business location.

integer

Filter by default language identifier for communications and UI.

integer

Filter by iD of the space website language linked to this record.

string

Filter by culture code (e.g. en-GB) for the business’s public website.

integer

Filter by iD of the root location linked to this record.

string

Filter by uRL slug used for the business’s public web address.

integer

Filter by iD of the default payment gateway linked to this record.

string

Filter by date of the next scheduled invoice run.

string

Filter by terms and conditions text for this business.

string

Filter by brief introduction shown on the business profile.

string

Filter by extended ‘About Us’ text for the business profile.

string

Filter by highlight quote displayed on the business profile.

string

Filter by uRL to the business’s privacy policy.

Filter by uRL to the business’s cookie policy.

string

Filter by public-facing web contact URL.

string

Filter by the welcome email value for this business.

string

Filter by street address of the business.

string

Filter by primary phone number displayed on the business profile.

string

Filter by fax number.

string

Filter by primary email address displayed on the business profile.

string

Filter by date/time value for trial expire date.

string

Filter by date/time value for last over due invoice reminder.

string

Filter by date/time value for last welcome email.

integer

Filter by iD of the country linked to this record.

string

Filter by name of the country (resolved from CountryId).

integer

Filter by iD of the currency linked to this record.

string

Filter by iSO currency code (resolved from CurrencyId).

integer

Filter by iD of the simple time zone linked to this record.

string

Filter by current file name of the logo (read-only; upload via the corresponding URL field).

string

Filter by uRL of a new file to upload as the logo.

boolean

Filter by set to true to remove the current logo file.

string

Filter by current file name of the banner image (read-only; upload via the corresponding URL field).

string

Filter by uRL of a new file to upload as the banner image.

boolean

Filter by set to true to remove the current banner image file.

string

Filter by current file name of the nex io banner image (read-only; upload via the corresponding URL field).

string

Filter by uRL of a new file to upload as the nex io banner image.

boolean

Filter by set to true to remove the current nex io banner image file.

number

Filter by the discount percentage value for this business.

number

Filter by the discount amount value for this business.

string

Filter by date/time value for last language token update.

boolean

Filter by whether has created default file templates is enabled.

integer

Filter by the invoicing period value for this business.

boolean

Filter by whether suspended is enabled.

boolean

Filter by whether custom passport app is enabled.

string

Filter by date/time value for reminders processed on.

string

Filter by iD of the pre auth associated with this record.

string

Filter by last 4 digits of the payment card on file.

string

Filter by most recent pre-authorisation error message.

string

Filter by date/time value for pre auth processed on.

integer

Filter by the last charged invoice value for this business.

integer

Filter by the last charged transaction value for this business.

integer

Filter by the last charged attendee value for this business.

string

Filter by passport channels this business is listed under.

boolean

Filter by whether passport only is enabled.

boolean

Filter by whether this business is published and visible on Nexudus Passport.

string

Filter by current file name of the passport banner (read-only; upload via the corresponding URL field).

string

Filter by uRL of a new file to upload as the passport banner.

boolean

Filter by set to true to remove the current passport banner file.

string

Filter by display name shown on the Nexudus Passport listing.

string

Filter by tagline shown on the Nexudus Passport listing.

integer

Filter by type of venue (0 = default).

string

Filter by comma-separated tags for categorising the business.

integer

Filter by number of floors in the business premises.

integer

Filter by total floor space of the business premises.

integer

Filter by unit for FloorSpace (0 = default).

number

Filter by longitude coordinate for map positioning.

number

Filter by latitude coordinate for map positioning.

string

Filter by full description shown on the Nexudus Passport listing.

string

Filter by town or city where the business is located.

string

Filter by state or province where the business is located.

string

Filter by postal or ZIP code.

string

Filter by street name component of the address.

string

Filter by street number component of the address.

string

Filter by neighborhood or district name.

string

Filter by secondary contact phone number.

string

Filter by secondary contact email address.

integer

Filter by passport members directory access level.

integer

Filter by passport events listing access level.

integer

Filter by passport community board access level.

integer

Filter by passport blog posts access level.

integer

Filter by monday opening time (minutes from midnight).

integer

Filter by monday closing time (minutes from midnight).

integer

Filter by tuesday opening time (minutes from midnight).

integer

Filter by tuesday closing time (minutes from midnight).

integer

Filter by wednesday opening time (minutes from midnight).

integer

Filter by wednesday closing time (minutes from midnight).

integer

Filter by thursday opening time (minutes from midnight).

integer

Filter by thursday closing time (minutes from midnight).

integer

Filter by friday opening time (minutes from midnight).

integer

Filter by friday closing time (minutes from midnight).

integer

Filter by saturday opening time (minutes from midnight).

integer

Filter by saturday closing time (minutes from midnight).

integer

Filter by sunday opening time (minutes from midnight).

integer

Filter by sunday closing time (minutes from midnight).

boolean

Filter by whether the business is closed on Mondays.

boolean

Filter by whether the business is closed on Tuesdays.

boolean

Filter by whether the business is closed on Wednesdays.

boolean

Filter by whether the business is closed on Thursdays.

boolean

Filter by whether the business is closed on Fridays.

boolean

Filter by whether the business is closed on Saturdays.

boolean

Filter by whether the business is closed on Sundays.

boolean

Filter by whether all days share the same opening and closing times.

string

Filter by name of the currently active website theme.

integer

Filter by the current back end version value for this business.

string

Filter by the authentication provider value for this business.

string

Filter by the created by value for this business.

integer

Filter by the default payment term value for this business.

string

Filter by onboarding support tier for this business.

string

Filter by customer support tier for this business.

string

Filter by uRL for the business’s support portal.

Range Filters

string

Filter by date of the next scheduled invoice run greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date of the next scheduled invoice run less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date/time value for trial expire date greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date/time value for trial expire date less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date/time value for last over due invoice reminder greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date/time value for last over due invoice reminder less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date/time value for last welcome email greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date/time value for last welcome email less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

number

Filter by the discount percentage value for this business greater than or equal to this value.

number

Filter by the discount percentage value for this business less than or equal to this value.

number

Filter by the discount amount value for this business greater than or equal to this value.

number

Filter by the discount amount value for this business less than or equal to this value.

string

Filter by date/time value for last language token update greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date/time value for last language token update less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

integer

Filter by the invoicing period value for this business greater than or equal to this value.

integer

Filter by the invoicing period value for this business less than or equal to this value.

string

Filter by date/time value for reminders processed on greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date/time value for reminders processed on less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date/time value for pre auth processed on greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date/time value for pre auth processed on less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

integer

Filter by the last charged invoice value for this business greater than or equal to this value.

integer

Filter by the last charged invoice value for this business less than or equal to this value.

integer

Filter by the last charged transaction value for this business greater than or equal to this value.

integer

Filter by the last charged transaction value for this business less than or equal to this value.

integer

Filter by the last charged attendee value for this business greater than or equal to this value.

integer

Filter by the last charged attendee value for this business less than or equal to this value.

integer

Filter by number of floors in the business premises greater than or equal to this value.

integer

Filter by number of floors in the business premises less than or equal to this value.

integer

Filter by total floor space of the business premises greater than or equal to this value.

integer

Filter by total floor space of the business premises less than or equal to this value.

number

Filter by longitude coordinate for map positioning greater than or equal to this value.

number

Filter by longitude coordinate for map positioning less than or equal to this value.

number

Filter by latitude coordinate for map positioning greater than or equal to this value.

number

Filter by latitude coordinate for map positioning less than or equal to this value.

integer

Filter by monday opening time (minutes from midnight) greater than or equal to this value.

integer

Filter by monday opening time (minutes from midnight) less than or equal to this value.

integer

Filter by monday closing time (minutes from midnight) greater than or equal to this value.

integer

Filter by monday closing time (minutes from midnight) less than or equal to this value.

integer

Filter by tuesday opening time (minutes from midnight) greater than or equal to this value.

integer

Filter by tuesday opening time (minutes from midnight) less than or equal to this value.

integer

Filter by tuesday closing time (minutes from midnight) greater than or equal to this value.

integer

Filter by tuesday closing time (minutes from midnight) less than or equal to this value.

integer

Filter by wednesday opening time (minutes from midnight) greater than or equal to this value.

integer

Filter by wednesday opening time (minutes from midnight) less than or equal to this value.

integer

Filter by wednesday closing time (minutes from midnight) greater than or equal to this value.

integer

Filter by wednesday closing time (minutes from midnight) less than or equal to this value.

integer

Filter by thursday opening time (minutes from midnight) greater than or equal to this value.

integer

Filter by thursday opening time (minutes from midnight) less than or equal to this value.

integer

Filter by thursday closing time (minutes from midnight) greater than or equal to this value.

integer

Filter by thursday closing time (minutes from midnight) less than or equal to this value.

integer

Filter by friday opening time (minutes from midnight) greater than or equal to this value.

integer

Filter by friday opening time (minutes from midnight) less than or equal to this value.

integer

Filter by friday closing time (minutes from midnight) greater than or equal to this value.

integer

Filter by friday closing time (minutes from midnight) less than or equal to this value.

integer

Filter by saturday opening time (minutes from midnight) greater than or equal to this value.

integer

Filter by saturday opening time (minutes from midnight) less than or equal to this value.

integer

Filter by saturday closing time (minutes from midnight) greater than or equal to this value.

integer

Filter by saturday closing time (minutes from midnight) less than or equal to this value.

integer

Filter by sunday opening time (minutes from midnight) greater than or equal to this value.

integer

Filter by sunday opening time (minutes from midnight) less than or equal to this value.

integer

Filter by sunday closing time (minutes from midnight) greater than or equal to this value.

integer

Filter by sunday closing time (minutes from midnight) less than or equal to this value.

integer

Filter by the current back end version value for this business greater than or equal to this value.

integer

Filter by the current back end version value for this business less than or equal to this value.

integer

Filter by the default payment term value for this business greater than or equal to this value.

integer

Filter by the default payment term value for this business less than or equal to this value.

string

Filter records created on or after this date. Format: YYYY-MM-DDTHH:mm.

string

Filter records created on or before this date. Format: YYYY-MM-DDTHH:mm.

string

Filter records updated on or after this date. Format: YYYY-MM-DDTHH:mm.

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/businesses?page=1&size=15&orderBy=Name&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/businesses?' + new URLSearchParams({
    page: 1,
    size: 15,
    orderBy: 'Name',
    dir: 1 // Ascending
  }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/sys/businesses',
    params={
        'page': 1,
        'size': 15,
        'orderBy': 'Name',
        'dir': 0 // Ascending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Filtering by Name

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

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/businesses?' + new URLSearchParams({
    Business_Name: 'example-value',
    orderBy: 'Name',
    dir: 1
  }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/sys/businesses',
    params={
        'Business_Name': 'example-value',
        'orderBy': 'Name',
        'dir': 0 // Ascending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Range filters

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

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/businesses?' + new URLSearchParams({
    from_Business_UpdatedOn: '2025-01-01T00:00',
    to_Business_UpdatedOn: '2025-12-31T23:59',
    orderBy: 'UpdatedOn',
    dir: 1 // Descending
   }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/sys/businesses',
    params={
        'from_Business_UpdatedOn': '2025-01-01T00:00',
        'to_Business_UpdatedOn': '2025-12-31T23:59',
        'orderBy': 'UpdatedOn',
        'dir': 1 // Descending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Response

200

Business[]

The list of Business records matching the query. See the Get one Business endpoint for the full list of properties returned for each record.

Partial records — The listing endpoint returns a summary representation of each Business. The following fields are not populated in the Records[] response: SpaceWebsiteLanguageId, TermsAndConditions, ShortIntroduction, AboutUs, Quote, PrivacyPolicyUrl, CookiePolicyUrl, WebContact, WelcomeEmail, Address, Phone, Fax, EmailContact, DiscountPercentage, PassportChannels, PassportPublished, PassportSpaceName, PassportTagLine, VenueType, Tags, NumberOfFloors, FloorSpace, FloorSpaceUnit, PassportDescription, TownCity, State, PostalCode, StreetName, StreetNumber, Neighborhood, ContactPhoneNumber, ContactEmail, PassportMembersAccess, PassportEventsAccess, PassportCommunityAccess, PassportBlogPostsAccess, MondayOpenTime, MondayCloseTime, TuesdayOpenTime, TuesdayCloseTime, WednesdayOpenTime, WednesdayCloseTime, ThursdayOpenTime, ThursdayCloseTime, FridayOpenTime, FridayCloseTime, SaturdayOpenTime, SaturdayCloseTime, SundayOpenTime, SundayCloseTime, MondayClosed, TuesdayClosed, WednesdayClosed, ThursdayClosed, FridayClosed, SaturdayClosed, SundayClosed, SameOpeningTimes.To get all fields, fetch the full record using the Get one Business endpoint.Important for updates: When updating a record via PUT, always retrieve the full record with a GET request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a PUT request, as missing fields may be unintentionally cleared.

integer

Current page number.

integer

Number of records per page.

string

The field used for sorting.

integer

The sort direction (0 = ascending, 1 = descending).

integer

Index of the first item on the current page.

integer

Index of the last item on the current page.

integer

Total number of matching records across all pages.

integer

Total number of pages.

boolean

Whether there is a next page of results.

boolean

Whether there is a previous page of results.

Example Response

{
  "Records": [
    {
      "VisitedHelpItems": 0,
      "Name": "",
      "DefaultLanguage": 0,
      "SpaceWebsiteLanguageCulture": null,
      "RootLocationId": null,
      "WebAddress": "",
      "DefaultPaymentGatewayId": null,
      "NextInvoice": null,
      "TrialExpireDate": null,
      "LastOverDueInvoiceReminder": null,
      "LastWelcomeEmail": null,
      "CountryId": 0,
      "CountryName": null,
      "CurrencyId": 0,
      "CurrencyCode": null,
      "SimpleTimeZoneId": 0,
      "LogoFileName": null,
      "NewLogoUrl": null,
      "ClearLogoFile": null,
      "BannerImageFileName": null,
      "NewBannerImageUrl": null,
      "ClearBannerImageFile": null,
      "NexIoBannerImageFileName": null,
      "NewNexIoBannerImageUrl": null,
      "ClearNexIoBannerImageFile": null,
      "DiscountAmount": 0,
      "LastLanguageTokenUpdate": null,
      "HasCreatedDefaultFileTemplates": false,
      "InvoicingPeriod": 0,
      "Suspended": false,
      "CustomPassportApp": false,
      "RemindersProcessedOn": null,
      "PreAuthId": null,
      "Last4Digits": null,
      "PreAuthLastError": null,
      "PreAuthProcessedOn": null,
      "LastChargedInvoice": 0,
      "LastChargedTransaction": 0,
      "LastChargedAttendee": 0,
      "PassportOnly": false,
      "PassportBannerFileName": null,
      "NewPassportBannerUrl": null,
      "ClearPassportBannerFile": null,
      "Longitude": null,
      "Latitude": null,
      "CurrentThemeName": null,
      "CurrentBackEndVersion": null,
      "AuthenticationProvider": null,
      "CreatedBy": null,
      "DefaultPaymentTerm": null,
      "OnBoardingTier": null,
      "SupportTier": null,
      "SupportUrl": 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": "Business 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
}

Get one BusinessRetrieve a single Business record by its Id.

Search Businesses

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

import requests

url = "https://spaces.nexudus.com/api/sys/businesses"

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

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Enums

Query Parameters

Filters

Range Filters

Code Examples

Simple listing

Filtering by Name

Range filters

Response

200

​Authentication

​Enums

​Query Parameters

​Pagination & Sorting

​Filters

​Range Filters

​Code Examples

​Simple listing

​Filtering by Name

​Range filters

​Response

​200

Authentication

Enums

Query Parameters

Pagination & Sorting

Filters

Range Filters

Code Examples

Simple listing

Filtering by Name

Range filters

Response

200