Get one Business

GET

api

sys

businesses

{id}

Get one Business

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

import requests

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

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

{
  "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

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"

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/businesses/87654321',
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const record = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/sys/businesses/87654321',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

record = response.json()

Response

200

integer

The visited help items value for this business. See eHelpItemFlag enum values: 0 = None, 1 = WelcomePage, 2 = GridPage, 4 = EditPage, 8 = SettingsPage, 16 = HelpPage.

string

Display name of the business location.

integer

Default language identifier for communications and UI. See eLanguage enum values: 3 = EnglishUK, 1 = EnglishUS, 2 = Spanish.

integer

ID of the space website language linked to this record.

string

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

integer

ID of the root location linked to this record.

string

URL slug used for the business’s public web address.

integer

ID of the default payment gateway linked to this record.

string

Date of the next scheduled invoice run.

string

Terms and conditions text for this business.

string

Brief introduction shown on the business profile.

string

Extended ‘About Us’ text for the business profile.

string

Highlight quote displayed on the business profile.

string

URL to the business’s privacy policy.

URL to the business’s cookie policy.

string

Public-facing web contact URL.

string

The welcome email value for this business.

string

Street address of the business.

string

Primary phone number displayed on the business profile.

string

Fax number.

string

Primary email address displayed on the business profile.

string

Date/time value for trial expire date.

string

Date/time value for last over due invoice reminder.

string

Date/time value for last welcome email.

integer

ID of the country linked to this record.

string

Name of the country (resolved from CountryId).

integer

ID of the currency linked to this record.

string

ISO currency code (resolved from CurrencyId).

integer

ID of the simple time zone linked to this record.

string

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

string

URL of a new file to upload as the logo.

boolean

Set to true to remove the current logo file.

string

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

string

URL of a new file to upload as the banner image.

boolean

Set to true to remove the current banner image file.

string

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

string

URL of a new file to upload as the nex io banner image.

boolean

Set to true to remove the current nex io banner image file.

number

The discount percentage value for this business.

number

The discount amount value for this business.

string

Date/time value for last language token update.

boolean

Whether has created default file templates is enabled.

integer

The invoicing period value for this business.

boolean

Whether suspended is enabled.

boolean

Whether custom passport app is enabled.

string

Date/time value for reminders processed on.

string

ID of the pre auth associated with this record.

string

Last 4 digits of the payment card on file.

string

Most recent pre-authorisation error message.

string

Date/time value for pre auth processed on.

integer

The last charged invoice value for this business.

integer

The last charged transaction value for this business.

integer

The last charged attendee value for this business.

string

Passport channels this business is listed under.

boolean

Whether passport only is enabled.

boolean

Whether this business is published and visible on Nexudus Passport.

string

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

string

URL of a new file to upload as the passport banner.

boolean

Set to true to remove the current passport banner file.

string

Display name shown on the Nexudus Passport listing.

string

Tagline shown on the Nexudus Passport listing.

integer

Type of venue (0 = default). See eVenueType enum values: 1 = BusinessCenter, 2 = CorporateOffice, 3 = CoworkingSpace, 4 = Hotel, 5 = InformalOffice, 6 = Studio, 7 = Other.

string

Comma-separated tags for categorising the business.

integer

Number of floors in the business premises.

integer

Total floor space of the business premises.

integer

Unit for FloorSpace (0 = default). See eFloorUnit enum values: 1 = SqFt, 2 = SqMt.

number

Longitude coordinate for map positioning.

number

Latitude coordinate for map positioning.

string

Full description shown on the Nexudus Passport listing.

string

Town or city where the business is located.

string

State or province where the business is located.

string

Postal or ZIP code.

string

Street name component of the address.

string

Street number component of the address.

string

Neighborhood or district name.

string

Secondary contact phone number.

string

Secondary contact email address.

integer

Passport members directory access level. See ePassportAccess enum values: 1 = Everyone, 2 = RegisteredUsers, 3 = RegisteredWithMySpaceUsers, 4 = NoOne.

integer

Passport events listing access level. See ePassportAccess enum values: 1 = Everyone, 2 = RegisteredUsers, 3 = RegisteredWithMySpaceUsers, 4 = NoOne.

integer

Passport community board access level. See ePassportAccess enum values: 1 = Everyone, 2 = RegisteredUsers, 3 = RegisteredWithMySpaceUsers, 4 = NoOne.

integer

Passport blog posts access level. See ePassportAccess enum values: 1 = Everyone, 2 = RegisteredUsers, 3 = RegisteredWithMySpaceUsers, 4 = NoOne.

integer

Monday opening time (minutes from midnight).

integer

Monday closing time (minutes from midnight).

integer

Tuesday opening time (minutes from midnight).

integer

Tuesday closing time (minutes from midnight).

integer

Wednesday opening time (minutes from midnight).

integer

Wednesday closing time (minutes from midnight).

integer

Thursday opening time (minutes from midnight).

integer

Thursday closing time (minutes from midnight).

integer

Friday opening time (minutes from midnight).

integer

Friday closing time (minutes from midnight).

integer

Saturday opening time (minutes from midnight).

integer

Saturday closing time (minutes from midnight).

integer

Sunday opening time (minutes from midnight).

integer

Sunday closing time (minutes from midnight).

boolean

Whether the business is closed on Mondays.

boolean

Whether the business is closed on Tuesdays.

boolean

Whether the business is closed on Wednesdays.

boolean

Whether the business is closed on Thursdays.

boolean

Whether the business is closed on Fridays.

boolean

Whether the business is closed on Saturdays.

boolean

Whether the business is closed on Sundays.

boolean

Whether all days share the same opening and closing times.

string

Name of the currently active website theme.

integer

The current back end version value for this business.

string

The authentication provider value for this business.

string

The created by value for this business.

integer

The default payment term value for this business.

string

Onboarding support tier for this business.

string

Customer support tier for this business.

string

URL for the business’s support portal.

integer

Unique record identifier.

string

UUID of the record.

string

Date and time the record was created (ISO 8601).

string

Date and time the record was last updated (ISO 8601).

string

Email of the user who last updated this record.

boolean

Whether the record was recently created.

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
}

Get multiple BusinessesRetrieve multiple Business records by their Ids in a single request.

Get one Business

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

import requests

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

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

{
  "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>"
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Path Parameters

Code Examples

Response

200

​Authentication

​Path Parameters

​Code Examples

​Response

​200

Authentication

Path Parameters

Code Examples

Response

200