Skip to main content
GET
/
api
/
sys
/
businesses
Search Businesses
curl --request GET \
  --url https://spaces.nexudus.com/api/sys/businesses \
  --header 'Authorization: Basic <encoded-value>'
{
  "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

ValueName
0None
1WelcomePage
2GridPage
4EditPage
8SettingsPage
16HelpPage
ValueName
3EnglishUK
1EnglishUS
2Spanish
ValueName
1BusinessCenter
2CorporateOffice
3CoworkingSpace
4Hotel
5InformalOffice
6Studio
7Other
ValueName
1SqFt
2SqMt
ValueName
1Everyone
2RegisteredUsers
3RegisteredWithMySpaceUsers
4NoOne

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. 0 for ascending, 1 for descending.

Filters

Business_VisitedHelpItems
integer
Filter by the visited help items value for this business.
Business_Name
string
Filter by display name of the business location.
Business_DefaultLanguage
integer
Filter by default language identifier for communications and UI.
Business_SpaceWebsiteLanguage
integer
Filter by iD of the space website language linked to this record.
Business_SpaceWebsiteLanguage_Culture
string
Filter by culture code (e.g. en-GB) for the business’s public website.
Business_RootLocation
integer
Filter by iD of the root location linked to this record.
Business_WebAddress
string
Filter by uRL slug used for the business’s public web address.
Business_DefaultPaymentGateway
integer
Filter by iD of the default payment gateway linked to this record.
Business_NextInvoice
string
Filter by date of the next scheduled invoice run.
Business_TermsAndConditions
string
Filter by terms and conditions text for this business.
Business_ShortIntroduction
string
Filter by brief introduction shown on the business profile.
Business_AboutUs
string
Filter by extended ‘About Us’ text for the business profile.
Business_Quote
string
Filter by highlight quote displayed on the business profile.
Business_PrivacyPolicyUrl
string
Filter by uRL to the business’s privacy policy.
Filter by uRL to the business’s cookie policy.
Business_WebContact
string
Filter by public-facing web contact URL.
Business_WelcomeEmail
string
Filter by the welcome email value for this business.
Business_Address
string
Filter by street address of the business.
Business_Phone
string
Filter by primary phone number displayed on the business profile.
Business_Fax
string
Filter by fax number.
Business_EmailContact
string
Filter by primary email address displayed on the business profile.
Business_TrialExpireDate
string
Filter by date/time value for trial expire date.
Business_LastOverDueInvoiceReminder
string
Filter by date/time value for last over due invoice reminder.
Business_LastWelcomeEmail
string
Filter by date/time value for last welcome email.
Business_Country
integer
Filter by iD of the country linked to this record.
Business_Country_Name
string
Filter by name of the country (resolved from CountryId).
Business_Currency
integer
Filter by iD of the currency linked to this record.
Business_Currency_Code
string
Filter by iSO currency code (resolved from CurrencyId).
Business_SimpleTimeZone
integer
Filter by iD of the simple time zone linked to this record.
Business_LogoFileName
string
Filter by current file name of the logo (read-only; upload via the corresponding URL field).
Business_NewLogoUrl
string
Filter by uRL of a new file to upload as the logo.
Filter by set to true to remove the current logo file.
Business_BannerImageFileName
string
Filter by current file name of the banner image (read-only; upload via the corresponding URL field).
Business_NewBannerImageUrl
string
Filter by uRL of a new file to upload as the banner image.
Business_ClearBannerImage
boolean
Filter by set to true to remove the current banner image file.
Business_NexIoBannerImageFileName
string
Filter by current file name of the nex io banner image (read-only; upload via the corresponding URL field).
Business_NewNexIoBannerImageUrl
string
Filter by uRL of a new file to upload as the nex io banner image.
Business_ClearNexIoBannerImage
boolean
Filter by set to true to remove the current nex io banner image file.
Business_DiscountPercentage
number
Filter by the discount percentage value for this business.
Business_DiscountAmount
number
Filter by the discount amount value for this business.
Business_LastLanguageTokenUpdate
string
Filter by date/time value for last language token update.
Business_HasCreatedDefaultFileTemplates
boolean
Filter by whether has created default file templates is enabled.
Business_InvoicingPeriod
integer
Filter by the invoicing period value for this business.
Business_Suspended
boolean
Filter by whether suspended is enabled.
Business_CustomPassportApp
boolean
Filter by whether custom passport app is enabled.
Business_RemindersProcessedOn
string
Filter by date/time value for reminders processed on.
Business_PreAuthId
string
Filter by iD of the pre auth associated with this record.
Business_Last4Digits
string
Filter by last 4 digits of the payment card on file.
Business_PreAuthLastError
string
Filter by most recent pre-authorisation error message.
Business_PreAuthProcessedOn
string
Filter by date/time value for pre auth processed on.
Business_LastChargedInvoice
integer
Filter by the last charged invoice value for this business.
Business_LastChargedTransaction
integer
Filter by the last charged transaction value for this business.
Business_LastChargedAttendee
integer
Filter by the last charged attendee value for this business.
Business_PassportChannels
string
Filter by passport channels this business is listed under.
Business_PassportOnly
boolean
Filter by whether passport only is enabled.
Business_PassportPublished
boolean
Filter by whether this business is published and visible on Nexudus Passport.
Business_PassportBannerFileName
string
Filter by current file name of the passport banner (read-only; upload via the corresponding URL field).
Business_NewPassportBannerUrl
string
Filter by uRL of a new file to upload as the passport banner.
Business_ClearPassportBanner
boolean
Filter by set to true to remove the current passport banner file.
Business_PassportSpaceName
string
Filter by display name shown on the Nexudus Passport listing.
Business_PassportTagLine
string
Filter by tagline shown on the Nexudus Passport listing.
Business_VenueType
integer
Filter by type of venue (0 = default).
Business_Tags
string
Filter by comma-separated tags for categorising the business.
Business_NumberOfFloors
integer
Filter by number of floors in the business premises.
Business_FloorSpace
integer
Filter by total floor space of the business premises.
Business_FloorSpaceUnit
integer
Filter by unit for FloorSpace (0 = default).
Business_Longitude
number
Filter by longitude coordinate for map positioning.
Business_Latitude
number
Filter by latitude coordinate for map positioning.
Business_PassportDescription
string
Filter by full description shown on the Nexudus Passport listing.
Business_TownCity
string
Filter by town or city where the business is located.
Business_State
string
Filter by state or province where the business is located.
Business_PostalCode
string
Filter by postal or ZIP code.
Business_StreetName
string
Filter by street name component of the address.
Business_StreetNumber
string
Filter by street number component of the address.
Business_Neighborhood
string
Filter by neighborhood or district name.
Business_ContactPhoneNumber
string
Filter by secondary contact phone number.
Business_ContactEmail
string
Filter by secondary contact email address.
Business_PassportMembersAccess
integer
Filter by passport members directory access level.
Business_PassportEventsAccess
integer
Filter by passport events listing access level.
Business_PassportCommunityAccess
integer
Filter by passport community board access level.
Business_PassportBlogPostsAccess
integer
Filter by passport blog posts access level.
Business_MondayOpenTime
integer
Filter by monday opening time (minutes from midnight).
Business_MondayCloseTime
integer
Filter by monday closing time (minutes from midnight).
Business_TuesdayOpenTime
integer
Filter by tuesday opening time (minutes from midnight).
Business_TuesdayCloseTime
integer
Filter by tuesday closing time (minutes from midnight).
Business_WednesdayOpenTime
integer
Filter by wednesday opening time (minutes from midnight).
Business_WednesdayCloseTime
integer
Filter by wednesday closing time (minutes from midnight).
Business_ThursdayOpenTime
integer
Filter by thursday opening time (minutes from midnight).
Business_ThursdayCloseTime
integer
Filter by thursday closing time (minutes from midnight).
Business_FridayOpenTime
integer
Filter by friday opening time (minutes from midnight).
Business_FridayCloseTime
integer
Filter by friday closing time (minutes from midnight).
Business_SaturdayOpenTime
integer
Filter by saturday opening time (minutes from midnight).
Business_SaturdayCloseTime
integer
Filter by saturday closing time (minutes from midnight).
Business_SundayOpenTime
integer
Filter by sunday opening time (minutes from midnight).
Business_SundayCloseTime
integer
Filter by sunday closing time (minutes from midnight).
Business_MondayClosed
boolean
Filter by whether the business is closed on Mondays.
Business_TuesdayClosed
boolean
Filter by whether the business is closed on Tuesdays.
Business_WednesdayClosed
boolean
Filter by whether the business is closed on Wednesdays.
Business_ThursdayClosed
boolean
Filter by whether the business is closed on Thursdays.
Business_FridayClosed
boolean
Filter by whether the business is closed on Fridays.
Business_SaturdayClosed
boolean
Filter by whether the business is closed on Saturdays.
Business_SundayClosed
boolean
Filter by whether the business is closed on Sundays.
Business_SameOpeningTimes
boolean
Filter by whether all days share the same opening and closing times.
Business_CurrentThemeName
string
Filter by name of the currently active website theme.
Business_CurrentBackEndVersion
integer
Filter by the current back end version value for this business.
Business_AuthenticationProvider
string
Filter by the authentication provider value for this business.
Business_CreatedBy
string
Filter by the created by value for this business.
Business_DefaultPaymentTerm
integer
Filter by the default payment term value for this business.
Business_OnBoardingTier
string
Filter by onboarding support tier for this business.
Business_SupportTier
string
Filter by customer support tier for this business.
Business_SupportUrl
string
Filter by uRL for the business’s support portal.

Range Filters

from_Business_NextInvoice
string
Filter by date of the next scheduled invoice run greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
to_Business_NextInvoice
string
Filter by date of the next scheduled invoice run less than or equal to this value. Format: YYYY-MM-DDTHH:mm.
from_Business_TrialExpireDate
string
Filter by date/time value for trial expire date greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
to_Business_TrialExpireDate
string
Filter by date/time value for trial expire date less than or equal to this value. Format: YYYY-MM-DDTHH:mm.
from_Business_LastOverDueInvoiceReminder
string
Filter by date/time value for last over due invoice reminder greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
to_Business_LastOverDueInvoiceReminder
string
Filter by date/time value for last over due invoice reminder less than or equal to this value. Format: YYYY-MM-DDTHH:mm.
from_Business_LastWelcomeEmail
string
Filter by date/time value for last welcome email greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
to_Business_LastWelcomeEmail
string
Filter by date/time value for last welcome email less than or equal to this value. Format: YYYY-MM-DDTHH:mm.
from_Business_DiscountPercentage
number
Filter by the discount percentage value for this business greater than or equal to this value.
to_Business_DiscountPercentage
number
Filter by the discount percentage value for this business less than or equal to this value.
from_Business_DiscountAmount
number
Filter by the discount amount value for this business greater than or equal to this value.
to_Business_DiscountAmount
number
Filter by the discount amount value for this business less than or equal to this value.
from_Business_LastLanguageTokenUpdate
string
Filter by date/time value for last language token update greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
to_Business_LastLanguageTokenUpdate
string
Filter by date/time value for last language token update less than or equal to this value. Format: YYYY-MM-DDTHH:mm.
from_Business_InvoicingPeriod
integer
Filter by the invoicing period value for this business greater than or equal to this value.
to_Business_InvoicingPeriod
integer
Filter by the invoicing period value for this business less than or equal to this value.
from_Business_RemindersProcessedOn
string
Filter by date/time value for reminders processed on greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
to_Business_RemindersProcessedOn
string
Filter by date/time value for reminders processed on less than or equal to this value. Format: YYYY-MM-DDTHH:mm.
from_Business_PreAuthProcessedOn
string
Filter by date/time value for pre auth processed on greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
to_Business_PreAuthProcessedOn
string
Filter by date/time value for pre auth processed on less than or equal to this value. Format: YYYY-MM-DDTHH:mm.
from_Business_LastChargedInvoice
integer
Filter by the last charged invoice value for this business greater than or equal to this value.
to_Business_LastChargedInvoice
integer
Filter by the last charged invoice value for this business less than or equal to this value.
from_Business_LastChargedTransaction
integer
Filter by the last charged transaction value for this business greater than or equal to this value.
to_Business_LastChargedTransaction
integer
Filter by the last charged transaction value for this business less than or equal to this value.
from_Business_LastChargedAttendee
integer
Filter by the last charged attendee value for this business greater than or equal to this value.
to_Business_LastChargedAttendee
integer
Filter by the last charged attendee value for this business less than or equal to this value.
from_Business_NumberOfFloors
integer
Filter by number of floors in the business premises greater than or equal to this value.
to_Business_NumberOfFloors
integer
Filter by number of floors in the business premises less than or equal to this value.
from_Business_FloorSpace
integer
Filter by total floor space of the business premises greater than or equal to this value.
to_Business_FloorSpace
integer
Filter by total floor space of the business premises less than or equal to this value.
from_Business_Longitude
number
Filter by longitude coordinate for map positioning greater than or equal to this value.
to_Business_Longitude
number
Filter by longitude coordinate for map positioning less than or equal to this value.
from_Business_Latitude
number
Filter by latitude coordinate for map positioning greater than or equal to this value.
to_Business_Latitude
number
Filter by latitude coordinate for map positioning less than or equal to this value.
from_Business_MondayOpenTime
integer
Filter by monday opening time (minutes from midnight) greater than or equal to this value.
to_Business_MondayOpenTime
integer
Filter by monday opening time (minutes from midnight) less than or equal to this value.
from_Business_MondayCloseTime
integer
Filter by monday closing time (minutes from midnight) greater than or equal to this value.
to_Business_MondayCloseTime
integer
Filter by monday closing time (minutes from midnight) less than or equal to this value.
from_Business_TuesdayOpenTime
integer
Filter by tuesday opening time (minutes from midnight) greater than or equal to this value.
to_Business_TuesdayOpenTime
integer
Filter by tuesday opening time (minutes from midnight) less than or equal to this value.
from_Business_TuesdayCloseTime
integer
Filter by tuesday closing time (minutes from midnight) greater than or equal to this value.
to_Business_TuesdayCloseTime
integer
Filter by tuesday closing time (minutes from midnight) less than or equal to this value.
from_Business_WednesdayOpenTime
integer
Filter by wednesday opening time (minutes from midnight) greater than or equal to this value.
to_Business_WednesdayOpenTime
integer
Filter by wednesday opening time (minutes from midnight) less than or equal to this value.
from_Business_WednesdayCloseTime
integer
Filter by wednesday closing time (minutes from midnight) greater than or equal to this value.
to_Business_WednesdayCloseTime
integer
Filter by wednesday closing time (minutes from midnight) less than or equal to this value.
from_Business_ThursdayOpenTime
integer
Filter by thursday opening time (minutes from midnight) greater than or equal to this value.
to_Business_ThursdayOpenTime
integer
Filter by thursday opening time (minutes from midnight) less than or equal to this value.
from_Business_ThursdayCloseTime
integer
Filter by thursday closing time (minutes from midnight) greater than or equal to this value.
to_Business_ThursdayCloseTime
integer
Filter by thursday closing time (minutes from midnight) less than or equal to this value.
from_Business_FridayOpenTime
integer
Filter by friday opening time (minutes from midnight) greater than or equal to this value.
to_Business_FridayOpenTime
integer
Filter by friday opening time (minutes from midnight) less than or equal to this value.
from_Business_FridayCloseTime
integer
Filter by friday closing time (minutes from midnight) greater than or equal to this value.
to_Business_FridayCloseTime
integer
Filter by friday closing time (minutes from midnight) less than or equal to this value.
from_Business_SaturdayOpenTime
integer
Filter by saturday opening time (minutes from midnight) greater than or equal to this value.
to_Business_SaturdayOpenTime
integer
Filter by saturday opening time (minutes from midnight) less than or equal to this value.
from_Business_SaturdayCloseTime
integer
Filter by saturday closing time (minutes from midnight) greater than or equal to this value.
to_Business_SaturdayCloseTime
integer
Filter by saturday closing time (minutes from midnight) less than or equal to this value.
from_Business_SundayOpenTime
integer
Filter by sunday opening time (minutes from midnight) greater than or equal to this value.
to_Business_SundayOpenTime
integer
Filter by sunday opening time (minutes from midnight) less than or equal to this value.
from_Business_SundayCloseTime
integer
Filter by sunday closing time (minutes from midnight) greater than or equal to this value.
to_Business_SundayCloseTime
integer
Filter by sunday closing time (minutes from midnight) less than or equal to this value.
from_Business_CurrentBackEndVersion
integer
Filter by the current back end version value for this business greater than or equal to this value.
to_Business_CurrentBackEndVersion
integer
Filter by the current back end version value for this business less than or equal to this value.
from_Business_DefaultPaymentTerm
integer
Filter by the default payment term value for this business greater than or equal to this value.
to_Business_DefaultPaymentTerm
integer
Filter by the default payment term value for this business less than or equal to this value.
from_Business_CreatedOn
string
Filter records created on or after this date. Format: YYYY-MM-DDTHH:mm.
to_Business_CreatedOn
string
Filter records created on or before this date. Format: YYYY-MM-DDTHH:mm.
from_Business_UpdatedOn
string
Filter records updated on or after this date. Format: YYYY-MM-DDTHH:mm.
to_Business_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/businesses?page=1&size=15&orderBy=Name&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

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"

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"

Response

200

Records
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.
CurrentPage
integer
Current page number.
CurrentPageSize
integer
Number of records per page.
CurrentOrderField
string
The field used for sorting.
CurrentSortDirection
integer
The sort direction (0 = 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": [
    {
      "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
}