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.
Query Parameters
The page number to retrieve.
The number of records per page.
The property name to sort results by (e.g. Name, CreatedOn).
Sort direction. 1 for ascending, -1 for descending.
Filters
Business_VisitedHelpItems
Filter by Visited Help Items.
Filter by display name of the business location.
Filter by default language identifier for communications and UI.
Business_SpaceWebsiteLanguage
Filter by Space Website Language Id.
Business_SpaceWebsiteLanguage_Culture
Filter by culture code (e.g. en-GB) for the business’s public website.
Filter by Root Location Id.
Filter by uRL slug used for the business’s public web address.
Business_DefaultPaymentGateway
Filter by Default Payment Gateway Id.
Filter by date of the next scheduled invoice run.
Business_TermsAndConditions
Filter by terms and conditions text for this business.
Business_ShortIntroduction
Filter by brief introduction shown on the business profile.
Filter by extended ‘About Us’ text for the business profile.
Filter by highlight quote displayed on the business profile.
Business_PrivacyPolicyUrl
Filter by uRL to the business’s privacy policy.
Filter by uRL to the business’s cookie policy.
Filter by public-facing web contact URL.
Filter by street address of the business.
Filter by primary phone number displayed on the business profile.
Filter by primary email address displayed on the business profile.
Filter by Trial Expire Date.
Business_LastOverDueInvoiceReminder
Filter by Last Over Due Invoice Reminder.
Business_LastWelcomeEmail
Filter by Last Welcome Email.
Filter by name of the country (resolved from CountryId).
Filter by iSO currency code (resolved from CurrencyId).
Filter by Simple Time Zone Id.
Filter by Logo File Name.
Filter by Clear Logo File.
Business_BannerImageFileName
Filter by Banner Image File Name.
Business_NewBannerImageUrl
Filter by New Banner Image Url.
Business_ClearBannerImage
Filter by Clear Banner Image File.
Business_NexIoBannerImageFileName
Filter by Nex Io Banner Image File Name.
Business_NewNexIoBannerImageUrl
Filter by New Nex Io Banner Image Url.
Business_ClearNexIoBannerImage
Filter by Clear Nex Io Banner Image File.
Business_DiscountPercentage
Filter by Discount Percentage.
Filter by Discount Amount.
Business_LastLanguageTokenUpdate
Filter by Last Language Token Update.
Business_HasCreatedDefaultFileTemplates
Filter by Has Created Default File Templates.
Filter by Invoicing Period.
Business_CustomPassportApp
Filter by Custom Passport App.
Business_RemindersProcessedOn
Filter by Reminders Processed On.
Filter by last 4 digits of the payment card on file.
Business_PreAuthLastError
Filter by most recent pre-authorisation error message.
Business_PreAuthProcessedOn
Filter by Pre Auth Processed On.
Business_LastChargedInvoice
Filter by Last Charged Invoice.
Business_LastChargedTransaction
Filter by Last Charged Transaction.
Business_LastChargedAttendee
Filter by Last Charged Attendee.
Business_PassportChannels
Filter by passport channels this business is listed under.
Business_PassportPublished
Filter by whether this business is published and visible on Nexudus Passport.
Business_PassportBannerFileName
Filter by Passport Banner File Name.
Business_NewPassportBannerUrl
Filter by New Passport Banner Url.
Business_ClearPassportBanner
Filter by Clear Passport Banner File.
Business_PassportSpaceName
Filter by display name shown on the Nexudus Passport listing.
Filter by tagline shown on the Nexudus Passport listing.
Filter by type of venue (0 = default).
Filter by comma-separated tags for categorising the business.
Filter by number of floors in the business premises.
Filter by total floor space of the business premises.
Filter by unit for FloorSpace (0 = default).
Filter by longitude coordinate for map positioning.
Filter by latitude coordinate for map positioning.
Business_PassportDescription
Filter by full description shown on the Nexudus Passport listing.
Filter by town or city where the business is located.
Filter by state or province where the business is located.
Filter by postal or ZIP code.
Filter by street name component of the address.
Filter by street number component of the address.
Filter by neighborhood or district name.
Business_ContactPhoneNumber
Filter by secondary contact phone number.
Filter by secondary contact email address.
Business_PassportMembersAccess
Filter by passport members directory access level.
Business_PassportEventsAccess
Filter by passport events listing access level.
Filter by passport community board access level.
Business_PassportBlogPostsAccess
Filter by passport blog posts access level.
Filter by monday opening time (minutes from midnight).
Filter by monday closing time (minutes from midnight).
Filter by tuesday opening time (minutes from midnight).
Business_TuesdayCloseTime
Filter by tuesday closing time (minutes from midnight).
Business_WednesdayOpenTime
Filter by wednesday opening time (minutes from midnight).
Business_WednesdayCloseTime
Filter by wednesday closing time (minutes from midnight).
Business_ThursdayOpenTime
Filter by thursday opening time (minutes from midnight).
Business_ThursdayCloseTime
Filter by thursday closing time (minutes from midnight).
Filter by friday opening time (minutes from midnight).
Filter by friday closing time (minutes from midnight).
Business_SaturdayOpenTime
Filter by saturday opening time (minutes from midnight).
Business_SaturdayCloseTime
Filter by saturday closing time (minutes from midnight).
Filter by sunday opening time (minutes from midnight).
Filter by sunday closing time (minutes from midnight).
Filter by whether the business is closed on Mondays.
Filter by whether the business is closed on Tuesdays.
Filter by whether the business is closed on Wednesdays.
Filter by whether the business is closed on Thursdays.
Filter by whether the business is closed on Fridays.
Filter by whether the business is closed on Saturdays.
Filter by whether the business is closed on Sundays.
Business_SameOpeningTimes
Filter by whether all days share the same opening and closing times.
Business_CurrentThemeName
Filter by name of the currently active website theme.
Business_CurrentBackEndVersion
Filter by Current Back End Version.
Business_AuthenticationProvider
Filter by Authentication Provider.
Business_DefaultPaymentTerm
Filter by Default Payment Term.
Filter by onboarding support tier for this business.
Filter by customer support tier for this business.
Filter by uRL for the business’s support portal.
Range Filters
from_Business_NextInvoice
Filter by date of the next scheduled invoice run greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
Filter by date of the next scheduled invoice run less than or equal to this value. Format: YYYY-MM-DDTHH:mm.
from_Business_TrialExpireDate
Filter by trial expire date greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
to_Business_TrialExpireDate
Filter by trial expire date less than or equal to this value. Format: YYYY-MM-DDTHH:mm.
from_Business_LastOverDueInvoiceReminder
Filter by last over due invoice reminder greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
to_Business_LastOverDueInvoiceReminder
Filter by last over due invoice reminder less than or equal to this value. Format: YYYY-MM-DDTHH:mm.
from_Business_LastWelcomeEmail
Filter by last welcome email greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
to_Business_LastWelcomeEmail
Filter by last welcome email less than or equal to this value. Format: YYYY-MM-DDTHH:mm.
from_Business_DiscountPercentage
Filter by discount percentage greater than or equal to this value.
to_Business_DiscountPercentage
Filter by discount percentage less than or equal to this value.
from_Business_DiscountAmount
Filter by discount amount greater than or equal to this value.
to_Business_DiscountAmount
Filter by discount amount less than or equal to this value.
from_Business_LastLanguageTokenUpdate
Filter by last language token update greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
to_Business_LastLanguageTokenUpdate
Filter by last language token update less than or equal to this value. Format: YYYY-MM-DDTHH:mm.
from_Business_InvoicingPeriod
Filter by invoicing period greater than or equal to this value.
to_Business_InvoicingPeriod
Filter by invoicing period less than or equal to this value.
from_Business_RemindersProcessedOn
Filter by reminders processed on greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
to_Business_RemindersProcessedOn
Filter by reminders processed on less than or equal to this value. Format: YYYY-MM-DDTHH:mm.
from_Business_PreAuthProcessedOn
Filter by pre auth processed on greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
to_Business_PreAuthProcessedOn
Filter by pre auth processed on less than or equal to this value. Format: YYYY-MM-DDTHH:mm.
from_Business_LastChargedInvoice
Filter by last charged invoice greater than or equal to this value.
to_Business_LastChargedInvoice
Filter by last charged invoice less than or equal to this value.
from_Business_LastChargedTransaction
Filter by last charged transaction greater than or equal to this value.
to_Business_LastChargedTransaction
Filter by last charged transaction less than or equal to this value.
from_Business_LastChargedAttendee
Filter by last charged attendee greater than or equal to this value.
to_Business_LastChargedAttendee
Filter by last charged attendee less than or equal to this value.
from_Business_NumberOfFloors
Filter by number of floors in the business premises greater than or equal to this value.
to_Business_NumberOfFloors
Filter by number of floors in the business premises less than or equal to this value.
Filter by total floor space of the business premises greater than or equal to this value.
Filter by total floor space of the business premises less than or equal to this value.
Filter by longitude coordinate for map positioning greater than or equal to this value.
Filter by longitude coordinate for map positioning less than or equal to this value.
Filter by latitude coordinate for map positioning greater than or equal to this value.
Filter by latitude coordinate for map positioning less than or equal to this value.
from_Business_MondayOpenTime
Filter by monday opening time (minutes from midnight) greater than or equal to this value.
to_Business_MondayOpenTime
Filter by monday opening time (minutes from midnight) less than or equal to this value.
from_Business_MondayCloseTime
Filter by monday closing time (minutes from midnight) greater than or equal to this value.
to_Business_MondayCloseTime
Filter by monday closing time (minutes from midnight) less than or equal to this value.
from_Business_TuesdayOpenTime
Filter by tuesday opening time (minutes from midnight) greater than or equal to this value.
to_Business_TuesdayOpenTime
Filter by tuesday opening time (minutes from midnight) less than or equal to this value.
from_Business_TuesdayCloseTime
Filter by tuesday closing time (minutes from midnight) greater than or equal to this value.
to_Business_TuesdayCloseTime
Filter by tuesday closing time (minutes from midnight) less than or equal to this value.
from_Business_WednesdayOpenTime
Filter by wednesday opening time (minutes from midnight) greater than or equal to this value.
to_Business_WednesdayOpenTime
Filter by wednesday opening time (minutes from midnight) less than or equal to this value.
from_Business_WednesdayCloseTime
Filter by wednesday closing time (minutes from midnight) greater than or equal to this value.
to_Business_WednesdayCloseTime
Filter by wednesday closing time (minutes from midnight) less than or equal to this value.
from_Business_ThursdayOpenTime
Filter by thursday opening time (minutes from midnight) greater than or equal to this value.
to_Business_ThursdayOpenTime
Filter by thursday opening time (minutes from midnight) less than or equal to this value.
from_Business_ThursdayCloseTime
Filter by thursday closing time (minutes from midnight) greater than or equal to this value.
to_Business_ThursdayCloseTime
Filter by thursday closing time (minutes from midnight) less than or equal to this value.
from_Business_FridayOpenTime
Filter by friday opening time (minutes from midnight) greater than or equal to this value.
to_Business_FridayOpenTime
Filter by friday opening time (minutes from midnight) less than or equal to this value.
from_Business_FridayCloseTime
Filter by friday closing time (minutes from midnight) greater than or equal to this value.
to_Business_FridayCloseTime
Filter by friday closing time (minutes from midnight) less than or equal to this value.
from_Business_SaturdayOpenTime
Filter by saturday opening time (minutes from midnight) greater than or equal to this value.
to_Business_SaturdayOpenTime
Filter by saturday opening time (minutes from midnight) less than or equal to this value.
from_Business_SaturdayCloseTime
Filter by saturday closing time (minutes from midnight) greater than or equal to this value.
to_Business_SaturdayCloseTime
Filter by saturday closing time (minutes from midnight) less than or equal to this value.
from_Business_SundayOpenTime
Filter by sunday opening time (minutes from midnight) greater than or equal to this value.
to_Business_SundayOpenTime
Filter by sunday opening time (minutes from midnight) less than or equal to this value.
from_Business_SundayCloseTime
Filter by sunday closing time (minutes from midnight) greater than or equal to this value.
to_Business_SundayCloseTime
Filter by sunday closing time (minutes from midnight) less than or equal to this value.
from_Business_CurrentBackEndVersion
Filter by current back end version greater than or equal to this value.
to_Business_CurrentBackEndVersion
Filter by current back end version less than or equal to this value.
from_Business_DefaultPaymentTerm
Filter by default payment term greater than or equal to this value.
to_Business_DefaultPaymentTerm
Filter by default payment term less than or equal to this value.
Filter records created on or after this date. Format: YYYY-MM-DDTHH:mm.
Filter records created on or before this date. Format: YYYY-MM-DDTHH:mm.
Filter records updated on or after this date. Format: YYYY-MM-DDTHH:mm.
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=1" \
-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=1" \
-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=-1" \
-H "Authorization: Bearer YOUR_TOKEN"
Response
200
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 included 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.
Number of records per page.
The field used for sorting.
The sort direction (1 = ascending, -1 = descending).
Index of the first item on the current page.
Index of the last item on the current page.
Total number of matching records across all pages.
Whether there is a next page of results.
Whether there is a previous page of results.
{
"Records": [
{
"VisitedHelpItems": 0,
"Name": "",
"DefaultLanguage": 0,
"SpaceWebsiteLanguageId": null,
"SpaceWebsiteLanguageCulture": null,
"RootLocationId": null,
"WebAddress": "",
"DefaultPaymentGatewayId": null,
"NextInvoice": null,
"TermsAndConditions": null,
"ShortIntroduction": null,
"AboutUs": null,
"Quote": null,
"PrivacyPolicyUrl": null,
"CookiePolicyUrl": null,
"WebContact": null,
"WelcomeEmail": null,
"Address": null,
"Phone": null,
"Fax": null,
"EmailContact": 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,
"DiscountPercentage": 0,
"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,
"PassportChannels": null,
"PassportOnly": false,
"PassportPublished": false,
"PassportBannerFileName": null,
"NewPassportBannerUrl": null,
"ClearPassportBannerFile": null,
"PassportSpaceName": null,
"PassportTagLine": null,
"VenueType": 0,
"Tags": null,
"NumberOfFloors": null,
"FloorSpace": null,
"FloorSpaceUnit": 0,
"Longitude": null,
"Latitude": null,
"PassportDescription": null,
"TownCity": null,
"State": null,
"PostalCode": null,
"StreetName": null,
"StreetNumber": null,
"Neighborhood": null,
"ContactPhoneNumber": null,
"ContactEmail": null,
"PassportMembersAccess": 0,
"PassportEventsAccess": 0,
"PassportCommunityAccess": 0,
"PassportBlogPostsAccess": 0,
"MondayOpenTime": null,
"MondayCloseTime": null,
"TuesdayOpenTime": null,
"TuesdayCloseTime": null,
"WednesdayOpenTime": null,
"WednesdayCloseTime": null,
"ThursdayOpenTime": null,
"ThursdayCloseTime": null,
"FridayOpenTime": null,
"FridayCloseTime": null,
"SaturdayOpenTime": null,
"SaturdayCloseTime": null,
"SundayOpenTime": null,
"SundayCloseTime": null,
"MondayClosed": false,
"TuesdayClosed": false,
"WednesdayClosed": false,
"ThursdayClosed": false,
"FridayClosed": false,
"SaturdayClosed": false,
"SundayClosed": false,
"SameOpeningTimes": false,
"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
}