Skip to main content
GET
/
api
/
sys
/
businesses
/
{id}
{
  "VisitedHelpItems": 123,
  "Name": "<string>",
  "DefaultLanguage": 123,
  "SpaceWebsiteLanguageId": 123,
  "SpaceWebsiteLanguageCulture": "<string>",
  "RootLocationId": 123,
  "WebAddress": "<string>",
  "DefaultPaymentGatewayId": 123,
  "NextInvoice": "<string>",
  "TermsAndConditions": "<string>",
  "ShortIntroduction": "<string>",
  "AboutUs": "<string>",
  "Quote": "<string>",
  "PrivacyPolicyUrl": "<string>",
  "CookiePolicyUrl": "<string>",
  "WebContact": "<string>",
  "WelcomeEmail": "<string>",
  "Address": "<string>",
  "Phone": "<string>",
  "Fax": "<string>",
  "EmailContact": "<string>",
  "TrialExpireDate": "<string>",
  "LastOverDueInvoiceReminder": "<string>",
  "LastWelcomeEmail": "<string>",
  "CountryId": 123,
  "CountryName": "<string>",
  "CurrencyId": 123,
  "CurrencyCode": "<string>",
  "SimpleTimeZoneId": 123,
  "LogoFileName": "<string>",
  "NewLogoUrl": "<string>",
  "ClearLogoFile": true,
  "BannerImageFileName": "<string>",
  "NewBannerImageUrl": "<string>",
  "ClearBannerImageFile": true,
  "NexIoBannerImageFileName": "<string>",
  "NewNexIoBannerImageUrl": "<string>",
  "ClearNexIoBannerImageFile": true,
  "DiscountPercentage": 123,
  "DiscountAmount": 123,
  "LastLanguageTokenUpdate": "<string>",
  "HasCreatedDefaultFileTemplates": true,
  "InvoicingPeriod": 123,
  "Suspended": true,
  "CustomPassportApp": true,
  "RemindersProcessedOn": "<string>",
  "PreAuthId": "<string>",
  "Last4Digits": "<string>",
  "PreAuthLastError": "<string>",
  "PreAuthProcessedOn": "<string>",
  "LastChargedInvoice": 123,
  "LastChargedTransaction": 123,
  "LastChargedAttendee": 123,
  "PassportChannels": "<string>",
  "PassportOnly": true,
  "PassportPublished": true,
  "PassportBannerFileName": "<string>",
  "NewPassportBannerUrl": "<string>",
  "ClearPassportBannerFile": true,
  "PassportSpaceName": "<string>",
  "PassportTagLine": "<string>",
  "VenueType": 123,
  "Tags": "<string>",
  "NumberOfFloors": 123,
  "FloorSpace": 123,
  "FloorSpaceUnit": 123,
  "Longitude": 123,
  "Latitude": 123,
  "PassportDescription": "<string>",
  "TownCity": "<string>",
  "State": "<string>",
  "PostalCode": "<string>",
  "StreetName": "<string>",
  "StreetNumber": "<string>",
  "Neighborhood": "<string>",
  "ContactPhoneNumber": "<string>",
  "ContactEmail": "<string>",
  "PassportMembersAccess": 123,
  "PassportEventsAccess": 123,
  "PassportCommunityAccess": 123,
  "PassportBlogPostsAccess": 123,
  "MondayOpenTime": 123,
  "MondayCloseTime": 123,
  "TuesdayOpenTime": 123,
  "TuesdayCloseTime": 123,
  "WednesdayOpenTime": 123,
  "WednesdayCloseTime": 123,
  "ThursdayOpenTime": 123,
  "ThursdayCloseTime": 123,
  "FridayOpenTime": 123,
  "FridayCloseTime": 123,
  "SaturdayOpenTime": 123,
  "SaturdayCloseTime": 123,
  "SundayOpenTime": 123,
  "SundayCloseTime": 123,
  "MondayClosed": true,
  "TuesdayClosed": true,
  "WednesdayClosed": true,
  "ThursdayClosed": true,
  "FridayClosed": true,
  "SaturdayClosed": true,
  "SundayClosed": true,
  "SameOpeningTimes": true,
  "CurrentThemeName": "<string>",
  "CurrentBackEndVersion": 123,
  "AuthenticationProvider": "<string>",
  "CreatedBy": "<string>",
  "DefaultPaymentTerm": 123,
  "OnBoardingTier": "<string>",
  "SupportTier": "<string>",
  "SupportUrl": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}
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-Read role.

​
Path Parameters

​
id
integer
required
The Id of the Business record to retrieve.

​
Code Examples

curl -X GET \
  "https://spaces.nexudus.com/api/sys/businesses/87654321" \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Response

​
200

​
VisitedHelpItems
integer
Visited Help Items.
​
Name
string
Display name of the business location.
​
DefaultLanguage
integer
Default language identifier for communications and UI.
​
SpaceWebsiteLanguageId
integer
Space Website Language Id.
​
SpaceWebsiteLanguageCulture
string
Culture code (e.g. en-GB) for the business’s public website.
​
RootLocationId
integer
Root Location Id.
​
WebAddress
string
URL slug used for the business’s public web address.
​
DefaultPaymentGatewayId
integer
Default Payment Gateway Id.
​
NextInvoice
string
Date of the next scheduled invoice run.
​
TermsAndConditions
string
Terms and conditions text for this business.
​
ShortIntroduction
string
Brief introduction shown on the business profile.
​
AboutUs
string
Extended ‘About Us’ text for the business profile.
​
Quote
string
Highlight quote displayed on the business profile.
​
PrivacyPolicyUrl
string
URL to the business’s privacy policy.
​
CookiePolicyUrl
string
URL to the business’s cookie policy.
​
WebContact
string
Public-facing web contact URL.
​
WelcomeEmail
string
Welcome Email.
​
Address
string
Street address of the business.
​
Phone
string
Primary phone number displayed on the business profile.
​
Fax
string
Fax number.
​
EmailContact
string
Primary email address displayed on the business profile.
​
TrialExpireDate
string
Trial Expire Date.
​
LastOverDueInvoiceReminder
string
Last Over Due Invoice Reminder.
​
LastWelcomeEmail
string
Last Welcome Email.
​
CountryId
integer
Country Id.
​
CountryName
string
Name of the country (resolved from CountryId).
​
CurrencyId
integer
Currency Id.
​
CurrencyCode
string
ISO currency code (resolved from CurrencyId).
​
SimpleTimeZoneId
integer
Simple Time Zone Id.
​
LogoFileName
string
Logo File Name.
​
NewLogoUrl
string
New Logo Url.
​
ClearLogoFile
boolean
Clear Logo File.
​
BannerImageFileName
string
Banner Image File Name.
​
NewBannerImageUrl
string
New Banner Image Url.
​
ClearBannerImageFile
boolean
Clear Banner Image File.
​
NexIoBannerImageFileName
string
Nex Io Banner Image File Name.
​
NewNexIoBannerImageUrl
string
New Nex Io Banner Image Url.
​
ClearNexIoBannerImageFile
boolean
Clear Nex Io Banner Image File.
​
DiscountPercentage
number
Discount Percentage.
​
DiscountAmount
number
Discount Amount.
​
LastLanguageTokenUpdate
string
Last Language Token Update.
​
HasCreatedDefaultFileTemplates
boolean
Has Created Default File Templates.
​
InvoicingPeriod
integer
Invoicing Period.
​
Suspended
boolean
Suspended.
​
CustomPassportApp
boolean
Custom Passport App.
​
RemindersProcessedOn
string
Reminders Processed On.
​
PreAuthId
string
Pre Auth Id.
​
Last4Digits
string
Last 4 digits of the payment card on file.
​
PreAuthLastError
string
Most recent pre-authorisation error message.
​
PreAuthProcessedOn
string
Pre Auth Processed On.
​
LastChargedInvoice
integer
Last Charged Invoice.
​
LastChargedTransaction
integer
Last Charged Transaction.
​
LastChargedAttendee
integer
Last Charged Attendee.
​
PassportChannels
string
Passport channels this business is listed under.
​
PassportOnly
boolean
Passport Only.
​
PassportPublished
boolean
Whether this business is published and visible on Nexudus Passport.
​
PassportBannerFileName
string
Passport Banner File Name.
​
NewPassportBannerUrl
string
New Passport Banner Url.
​
ClearPassportBannerFile
boolean
Clear Passport Banner File.
​
PassportSpaceName
string
Display name shown on the Nexudus Passport listing.
​
PassportTagLine
string
Tagline shown on the Nexudus Passport listing.
​
VenueType
integer
Type of venue (0 = default).
​
Tags
string
Comma-separated tags for categorising the business.
​
NumberOfFloors
integer
Number of floors in the business premises.
​
FloorSpace
integer
Total floor space of the business premises.
​
FloorSpaceUnit
integer
Unit for FloorSpace (0 = default).
​
Longitude
number
Longitude coordinate for map positioning.
​
Latitude
number
Latitude coordinate for map positioning.
​
PassportDescription
string
Full description shown on the Nexudus Passport listing.
​
TownCity
string
Town or city where the business is located.
​
State
string
State or province where the business is located.
​
PostalCode
string
Postal or ZIP code.
​
StreetName
string
Street name component of the address.
​
StreetNumber
string
Street number component of the address.
​
Neighborhood
string
Neighborhood or district name.
​
ContactPhoneNumber
string
Secondary contact phone number.
​
ContactEmail
string
Secondary contact email address.
​
PassportMembersAccess
integer
Passport members directory access level.
​
PassportEventsAccess
integer
Passport events listing access level.
​
PassportCommunityAccess
integer
Passport community board access level.
​
PassportBlogPostsAccess
integer
Passport blog posts access level.
​
MondayOpenTime
integer
Monday opening time (minutes from midnight).
​
MondayCloseTime
integer
Monday closing time (minutes from midnight).
​
TuesdayOpenTime
integer
Tuesday opening time (minutes from midnight).
​
TuesdayCloseTime
integer
Tuesday closing time (minutes from midnight).
​
WednesdayOpenTime
integer
Wednesday opening time (minutes from midnight).
​
WednesdayCloseTime
integer
Wednesday closing time (minutes from midnight).
​
ThursdayOpenTime
integer
Thursday opening time (minutes from midnight).
​
ThursdayCloseTime
integer
Thursday closing time (minutes from midnight).
​
FridayOpenTime
integer
Friday opening time (minutes from midnight).
​
FridayCloseTime
integer
Friday closing time (minutes from midnight).
​
SaturdayOpenTime
integer
Saturday opening time (minutes from midnight).
​
SaturdayCloseTime
integer
Saturday closing time (minutes from midnight).
​
SundayOpenTime
integer
Sunday opening time (minutes from midnight).
​
SundayCloseTime
integer
Sunday closing time (minutes from midnight).
​
MondayClosed
boolean
Whether the business is closed on Mondays.
​
TuesdayClosed
boolean
Whether the business is closed on Tuesdays.
​
WednesdayClosed
boolean
Whether the business is closed on Wednesdays.
​
ThursdayClosed
boolean
Whether the business is closed on Thursdays.
​
FridayClosed
boolean
Whether the business is closed on Fridays.
​
SaturdayClosed
boolean
Whether the business is closed on Saturdays.
​
SundayClosed
boolean
Whether the business is closed on Sundays.
​
SameOpeningTimes
boolean
Whether all days share the same opening and closing times.
​
CurrentThemeName
string
Name of the currently active website theme.
​
CurrentBackEndVersion
integer
Current Back End Version.
​
AuthenticationProvider
string
Authentication Provider.
​
CreatedBy
string
Created By.
​
DefaultPaymentTerm
integer
Default Payment Term.
​
OnBoardingTier
string
Onboarding support tier for this business.
​
SupportTier
string
Customer support tier for this business.
​
SupportUrl
string
URL for the business’s support portal.
​
Id
integer
Unique record identifier.
​
UniqueId
string
UUID of the record.
​
CreatedOn
string
Date and time the record was created (ISO 8601).
​
UpdatedOn
string
Date and time the record was last updated (ISO 8601).
​
UpdatedBy
string
Email of the user who last updated this record.
​
IsNew
boolean
Whether the record was recently created.
​
SystemId
string
External system identifier.
Example Response
{
  "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
}