> ## Documentation Index > Fetch the complete documentation index at: https://learn.nexudus.com/llms.txt > Use this file to discover all available pages before exploring further. # Search Businesses > Search and list Business records with filtering, sorting, and pagination. 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 | Value | Name | | ----- | ------------ | | 0 | None | | 1 | WelcomePage | | 2 | GridPage | | 4 | EditPage | | 8 | SettingsPage | | 16 | HelpPage | | Value | Name | | ----- | --------- | | 3 | EnglishUK | | 1 | EnglishUS | | 2 | Spanish | | Value | Name | | ----- | --------------- | | 1 | BusinessCenter | | 2 | CorporateOffice | | 3 | CoworkingSpace | | 4 | Hotel | | 5 | InformalOffice | | 6 | Studio | | 7 | Other | | Value | Name | | ----- | ---- | | 1 | SqFt | | 2 | SqMt | | Value | Name | | ----- | -------------------------- | | 1 | Everyone | | 2 | RegisteredUsers | | 3 | RegisteredWithMySpaceUsers | | 4 | NoOne | ## Query Parameters ### Pagination & Sorting The page number to retrieve. The number of records per page. The property name to sort results by (e.g. `Name`, `CreatedOn`). Sort direction. `0` for ascending, `1` for descending. ### Filters Filter by the visited help items value for this business. Filter by display name of the business location. Filter by default language identifier for communications and UI. Filter by iD of the space website language linked to this record. Filter by culture code (e.g. en-GB) for the business's public website. Filter by iD of the root location linked to this record. Filter by uRL slug used for the business's public web address. Filter by iD of the default payment gateway linked to this record. Filter by date of the next scheduled invoice run. Filter by terms and conditions text for this business. 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. 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 the welcome email value for this business. Filter by street address of the business. Filter by primary phone number displayed on the business profile. Filter by fax number. Filter by primary email address displayed on the business profile. Filter by date/time value for trial expire date. Filter by date/time value for last over due invoice reminder. Filter by date/time value for last welcome email. Filter by iD of the country linked to this record. Filter by name of the country (resolved from CountryId). Filter by iD of the currency linked to this record. Filter by iSO currency code (resolved from CurrencyId). Filter by iD of the simple time zone linked to this record. Filter by current file name of the logo (read-only; upload via the corresponding URL field). Filter by uRL of a new file to upload as the logo. Filter by set to true to remove the current logo file. Filter by current file name of the banner image (read-only; upload via the corresponding URL field). Filter by uRL of a new file to upload as the banner image. Filter by set to true to remove the current banner image file. Filter by current file name of the nex io banner image (read-only; upload via the corresponding URL field). Filter by uRL of a new file to upload as the nex io banner image. Filter by set to true to remove the current nex io banner image file. Filter by the discount percentage value for this business. Filter by the discount amount value for this business. Filter by date/time value for last language token update. Filter by whether has created default file templates is enabled. Filter by the invoicing period value for this business. Filter by whether suspended is enabled. Filter by whether custom passport app is enabled. Filter by date/time value for reminders processed on. Filter by iD of the pre auth associated with this record. Filter by last 4 digits of the payment card on file. Filter by most recent pre-authorisation error message. Filter by date/time value for pre auth processed on. Filter by the last charged invoice value for this business. Filter by the last charged transaction value for this business. Filter by the last charged attendee value for this business. Filter by passport channels this business is listed under. Filter by whether passport only is enabled. Filter by whether this business is published and visible on Nexudus Passport. Filter by current file name of the passport banner (read-only; upload via the corresponding URL field). Filter by uRL of a new file to upload as the passport banner. Filter by set to true to remove the current passport banner file. 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. 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. Filter by secondary contact phone number. Filter by secondary contact email address. Filter by passport members directory access level. Filter by passport events listing access level. Filter by passport community board access level. 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). Filter by tuesday closing time (minutes from midnight). Filter by wednesday opening time (minutes from midnight). Filter by wednesday closing time (minutes from midnight). Filter by thursday opening time (minutes from midnight). Filter by thursday closing time (minutes from midnight). Filter by friday opening time (minutes from midnight). Filter by friday closing time (minutes from midnight). Filter by saturday opening time (minutes from midnight). 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. Filter by whether all days share the same opening and closing times. Filter by name of the currently active website theme. Filter by the current back end version value for this business. Filter by the authentication provider value for this business. Filter by the created by value for this business. Filter by the default payment term value for this business. 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 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`. Filter by date/time value for trial expire date greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by date/time value for trial expire date less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by date/time value for last over due invoice reminder greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by date/time value for last over due invoice reminder less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by date/time value for last welcome email greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by date/time value for last welcome email less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by the discount percentage value for this business greater than or equal to this value. Filter by the discount percentage value for this business less than or equal to this value. Filter by the discount amount value for this business greater than or equal to this value. Filter by the discount amount value for this business less than or equal to this value. Filter by date/time value for last language token update greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by date/time value for last language token update less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by the invoicing period value for this business greater than or equal to this value. Filter by the invoicing period value for this business less than or equal to this value. Filter by date/time value for reminders processed on greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by date/time value for reminders processed on less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by date/time value for pre auth processed on greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by date/time value for pre auth processed on less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by the last charged invoice value for this business greater than or equal to this value. Filter by the last charged invoice value for this business less than or equal to this value. Filter by the last charged transaction value for this business greater than or equal to this value. Filter by the last charged transaction value for this business less than or equal to this value. Filter by the last charged attendee value for this business greater than or equal to this value. Filter by the last charged attendee value for this business less than or equal to this value. Filter by number of floors in the business premises greater than or equal to this value. 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. Filter by monday opening time (minutes from midnight) greater than or equal to this value. Filter by monday opening time (minutes from midnight) less than or equal to this value. Filter by monday closing time (minutes from midnight) greater than or equal to this value. Filter by monday closing time (minutes from midnight) less than or equal to this value. Filter by tuesday opening time (minutes from midnight) greater than or equal to this value. Filter by tuesday opening time (minutes from midnight) less than or equal to this value. Filter by tuesday closing time (minutes from midnight) greater than or equal to this value. Filter by tuesday closing time (minutes from midnight) less than or equal to this value. Filter by wednesday opening time (minutes from midnight) greater than or equal to this value. Filter by wednesday opening time (minutes from midnight) less than or equal to this value. Filter by wednesday closing time (minutes from midnight) greater than or equal to this value. Filter by wednesday closing time (minutes from midnight) less than or equal to this value. Filter by thursday opening time (minutes from midnight) greater than or equal to this value. Filter by thursday opening time (minutes from midnight) less than or equal to this value. Filter by thursday closing time (minutes from midnight) greater than or equal to this value. Filter by thursday closing time (minutes from midnight) less than or equal to this value. Filter by friday opening time (minutes from midnight) greater than or equal to this value. Filter by friday opening time (minutes from midnight) less than or equal to this value. Filter by friday closing time (minutes from midnight) greater than or equal to this value. Filter by friday closing time (minutes from midnight) less than or equal to this value. Filter by saturday opening time (minutes from midnight) greater than or equal to this value. Filter by saturday opening time (minutes from midnight) less than or equal to this value. Filter by saturday closing time (minutes from midnight) greater than or equal to this value. Filter by saturday closing time (minutes from midnight) less than or equal to this value. Filter by sunday opening time (minutes from midnight) greater than or equal to this value. Filter by sunday opening time (minutes from midnight) less than or equal to this value. Filter by sunday closing time (minutes from midnight) greater than or equal to this value. Filter by sunday closing time (minutes from midnight) less than or equal to this value. Filter by the current back end version value for this business greater than or equal to this value. Filter by the current back end version value for this business less than or equal to this value. Filter by the default payment term value for this business greater than or equal to this value. Filter by the default payment term value for this business 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 ```bash cURL theme={null} curl -X GET \ "https://spaces.nexudus.com/api/sys/businesses?page=1&size=15&orderBy=Name&dir=0" \ -H "Authorization: Bearer YOUR_TOKEN" ``` ```javascript JavaScript theme={null} 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(); ``` ```python Python theme={null} 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 ```bash cURL theme={null} curl -X GET \ "https://spaces.nexudus.com/api/sys/businesses?Business_Name=example-value&orderBy=Name&dir=0" \ -H "Authorization: Bearer YOUR_TOKEN" ``` ```javascript JavaScript theme={null} 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(); ``` ```python Python theme={null} 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 ```bash cURL theme={null} 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" ``` ```javascript JavaScript theme={null} 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(); ``` ```python Python theme={null} 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 The list of Business records matching the query. See the [Get one Business](/rest-api/sys/get-businesses-by-id) 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](/rest-api/sys/get-businesses-by-id) 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. Current page number. Number of records per page. The field used for sorting. The sort direction (`0` = 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. Total number of pages. Whether there is a next page of results. Whether there is a previous page of results. ```json Example Response theme={null} { "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 } ```