> ## 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.
# Entity Reference
> Complete index of all entity types available in the Nexudus CLI with their supported operations.
# Entity Reference
The Nexudus CLI supports 100+ entity types. Each entity follows the same consistent command pattern and maps to a Nexudus REST API endpoint.
This list grows with each release. Run `nexudus --help` to see all currently available entity commands, or run `nexudus doctor --agent` for the full
list.
## Supported entities
| Entity | CLI command | Operations | API module |
| ---------------------------------- | ------------------------------------- | ------------------------------------------- | ------------- |
| AccessToken | `accesstokens` | list, get, create, update, delete | spaces |
| Application | `applications` | list, get, create, update, delete | apps |
| AudioFile | `audiofiles` | list, get, create, update, delete | content |
| AuditTrailEntry | `audittrailentries` | list, get | sys |
| AutomationTile | `automationtiles` | list, get, create, update, delete | sys |
| AutomationTileAudit | `automationtileaudits` | list, get, create, update, delete | sys |
| BasketSession | `basketsessions` | list, get, create, update, delete | billing |
| BlogCategory | `blogcategories` | list, get, create, update, delete | content |
| BlogPost | `blogposts` | list, get, create, update, delete | content |
| BlogPostComment | `blogpostcomments` | list, get, create, update, delete | content |
| Booking | `bookings` | list, get, create, update, delete | spaces |
| BookingAvailabilityException | `bookingavailabilityexceptions` | list, get, create, update, delete | spaces |
| BookingNote | `bookingnotes` | list, get, create, update, delete | spaces |
| BookingProduct | `bookingproducts` | list, get, create, update, delete | spaces |
| BookingVisitor | `bookingvisitors` | list, get, create, update, delete | spaces |
| Business | `businesses` | list, get, update | sys |
| BusinessAnnouncement | `businessannouncements` | list, get, create, update, delete | content |
| BusinessBackgroundJob | `businessbackgroundjobs` | list, get | sys |
| BusinessCharge | `businesscharges` | list, get, create, update, delete | billing |
| BusinessDomain | `businessdomains` | list, get, create, update, delete | sys |
| BusinessRedirection | `businessredirections` | list, get, create, update, delete | sys |
| BusinessSetting | `businesssettings` | list, get, create, update, delete | sys |
| BusinessTimeSlot | `businesstimeslots` | list, get, create, update, delete | sys |
| CalendarEvent | `calendarevents` | list, get, create, update, delete | content |
| CalendarEventCategory | `calendareventcategories` | list, get, create, update, delete | content |
| CancelledBooking | `cancelledbookings` | list, get, create, update, delete | spaces |
| CannedResponse | `cannedresponses` | list, get, create, update, delete | crm |
| Charge | `charges` | list, get, create, update, delete | billing |
| ChatRoom | `chatrooms` | list, get, create, update, delete | support |
| ChatUserMessage | `chatusermessages` | list, get, create, update, delete | sys |
| Checkin | `checkins` | list, get, create, update, delete | spaces |
| CommunityGroup | `communitygroups` | list, get, create, update, delete | community |
| CommunityMessage | `communitymessages` | list, get, create, update, delete | community |
| CommunityMessageLike | `communitymessagelikes` | list, get, create, update, delete | community |
| CommunityPerk | `communityperks` | list, get, create, update, delete | content |
| CommunityThread | `communitythreads` | list, get, create, update, delete | community |
| CommunityThreadFile | `communitythreadfiles` | list, get, create, update, delete | community |
| CommunityThreadFollow | `communitythreadfollows` | list, get, create, update, delete | community |
| CommunityThreadLike | `communitythreadlikes` | list, get, create, update, delete | community |
| CommunityThreadMute | `communitythreadmutes` | list, get, create, update, delete | community |
| ContractContact | `contractcontacts` | list, get, create, update, delete | billing |
| ContractDeposit | `contractdeposits` | list, get, create, update, delete | billing |
| ContractPausedPeriod | `contractpausedperiods` | list, get, create, update, delete | billing |
| ContractProduct | `contractproducts` | list, get, create, update, delete | billing |
| ContractSchedule | `contractschedules` | list, get, create, update, delete | billing |
| Country | `countries` | list, get | sys |
| Course | `courses` | list, get, create, update, delete | content |
| CourseCompletedLesson | `coursecompletedlessons` | list, get, create, update, delete | content |
| CourseLesson | `courselessons` | list, get, create, update, delete | content |
| CourseMember | `coursemembers` | list, get, create, update, delete | content |
| CourseSection | `coursesections` | list, get, create, update, delete | content |
| Coworker | `coworkers` | list, get, create, update, commands | spaces |
| CoworkerAccessControlAudit | `coworkeraccesscontrolaudits` | list, get, create, update, delete | sys |
| CoworkerBookingCredit | `coworkerbookingcredits` | list, get, create, update, delete | billing |
| CoworkerBookingCreditUseHistory | `coworkerbookingcreditusehistories` | list, get, create, update | billing |
| CoworkerContract | `coworkercontracts` | list, get, create, update, delete | billing |
| CoworkerDataFile | `coworkerdatafiles` | list, get, create, update, delete | spaces |
| CoworkerDelivery | `coworkerdeliveries` | list, get, create, update, delete | spaces |
| CoworkerDiscountCode | `coworkerdiscountcodes` | list, get, create, update, delete | billing |
| CoworkerExtraService | `coworkerextraservices` | list, get, create, update, delete | billing |
| CoworkerExtraServiceUseHistory | `coworkerextraserviceusehistories` | list, get, create, update, delete | billing |
| CoworkerGoogleCalendar | `coworkergooglecalendars` | list, get, create, update, delete | spaces |
| CoworkerIdentityCheck | `coworkeridentitychecks` | list, get, create, update, delete | spaces |
| CoworkerIdentityCheckDocument | `coworkeridentitycheckdocuments` | list, get, create, update, delete | spaces |
| CoworkerInventoryAsset | `coworkerinventoryassets` | list, get, create, update, delete | spaces |
| CoworkerInvoice | `coworkerinvoices` | list, get, update | billing |
| CoworkerInvoiceHistory | `coworkerinvoicehistories` | list, get, create, update, delete | billing |
| CoworkerInvoiceLine | `coworkerinvoicelines` | list, get, update | billing |
| CoworkerInvoicePaymentToken | `coworkerinvoicepaymenttokens` | list, get, create, update, delete | billing |
| CoworkerLedgerEntry | `coworkerledgerentries` | list, get, create, update, delete | billing |
| CoworkerLegalContentAudit | `coworkerlegalcontentaudits` | list, get, create, update, delete | sys |
| CoworkerMessage | `coworkermessages` | list, get | spaces |
| CoworkerMsOfficeCalendar | `coworkermsoffecalendars` | list, get, create, update, delete | spaces |
| CoworkerMsOfficeCalendar | `coworkermsofficecalendars` | list, get, create, update, delete | spaces |
| CoworkerNote | `coworkernotes` | list, get, create, update, delete | spaces |
| CoworkerNotification | `coworkernotifications` | list, get, create, update, delete | spaces |
| CoworkerPaymentMethod | `coworkerpaymentmethods` | list, get, create, update, delete | billing |
| CoworkerPricePlanHistory | `coworkerpriceplanhistories` | list, get | spaces |
| CoworkerProduct | `coworkerproducts` | list, get, create, update, delete | billing |
| CoworkerReminderAudit | `coworkerreminderaudits` | list, get, create, update, delete | crm |
| CoworkerSetting | `coworkersettings` | list, get, create, update, delete | spaces |
| CoworkerTask | `coworkertasks` | list, get, create, update, delete | crm |
| CoworkerTimePass | `coworkertimepasses` | list, get, create, update, delete | billing |
| CrmBoard | `crmboards` | list, get, create, update, delete | crm |
| CrmBoardColumn | `crmboardcolumns` | list, get, create, update, delete | crm |
| CrmOpportunity | `crmopportunities` | list, get, create, update, delete | crm |
| CrmOpportunityHistory | `crmopportunityhistories` | list, get, create, update, delete | crm |
| CrmOpportunityImportFile | `crmopportunityimportfiles` | list, get, create, update, delete | crm |
| Currency | `currencies` | list, get | sys |
| CustomField | `customfields` | list, get, create, update, delete | crm |
| DataFile | `datafiles` | list, get, create, update, delete | content |
| DiscountCode | `discountcodes` | list, get, create, update, delete | billing |
| DocumentTemplate | `documenttemplates` | list, get, create, update, delete | crm |
| EloxxLockersAudit | `eloxxlockersaudits` | list, get, create, update, delete | sys |
| EmailAccount | `emailaccounts` | list, get, create, update, delete | crm |
| EmailQueueItem | `emailqueueitems` | list, get | sys |
| EmailQueueItemAttachment | `emailqueueitemattachments` | list, get, update | sys |
| EmailTemplateFile | `emailtemplatefiles` | list, get, create, update, delete | sys |
| EventAttendee | `eventattendees` | list, get, create, update, delete | content |
| EventComment | `eventcomments` | list, get, create, update, delete | content |
| EventProduct | `eventproducts` | list, get, create, update, delete | content |
| EventWaitingAttendee | `eventwaitingattendees` | list, get, create, update, delete | content |
| ExtraService | `extraservices` | list, get, create, update, delete | billing |
| ExtraServicePrice | `extraserviceprices` | list, get, create, update, delete | billing |
| ExtraServiceTimeSlot | `extraservicetimeslots` | list, get, create, update, delete | billing |
| FailedCheckin | `failedcheckins` | list, get, create, update, delete | spaces |
| FaqArticle | `faqarticles` | list, get, create, update, delete | content |
| FinancialAccount | `financialaccounts` | list, get, create, update, delete | billing |
| FloorPlan | `floorplans` | list, get, create, update, delete | sys |
| FloorPlanAsset | `floorplanassets` | list, get | sys |
| FloorPlanDesk | `floorplandesks` | list, get, create, update, delete | sys |
| FloorPlanDeskVariant | `floorplandeskvariants` | list, get, create, update, delete | sys |
| FloorPlanLayout | `floorplanlayouts` | list, get, create, update, delete | sys |
| FloorPlanLayoutArea | `floorplanlayoutareas` | list, get, create, update, delete | sys |
| FloorPlanLayoutAsset | `floorplanlayoutassets` | list, get, create, update, delete | sys |
| FloorPlanLayoutEdge | `floorplanlayoutedges` | list, get, create, update, delete | sys |
| FloorPlanLayoutNode | `floorplanlayoutnodes` | list, get, create, update, delete | sys |
| FloorPlanLayoutOpening | `floorplanlayoutopenings` | list, get, create, update, delete | sys |
| FloorplanLayoutTransition | `floorplanlayouttransitions` | list, get, create, update, delete | sys |
| FormPage | `formpages` | list, get, create, update, delete | content |
| FormPageAnswer | `formpageanswers` | list, get, create, update | content |
| FormPageQuestion | `formpagequestions` | list, get, create, update, delete | content |
| FormPageRequest | `formpagerequests` | list, get, create, update, delete | content |
| GlobalChatMessage | `globalchatmessages` | list, get, create, update, delete | support |
| HelpDeskComment | `helpdeskcomments` | list, get, create, update, delete | support |
| HelpDeskDepartment | `helpdeskdepartments` | list, get, create, update, delete | support |
| HelpDeskMessage | `helpdeskmessages` | list, get, create, update, delete | support |
| ImageFile | `imagefiles` | list, get, create, update, delete | content |
| InstalledApplication | `installedapplications` | list, get, create, update, delete | apps |
| InstalledMarketPlaceApplication | `installedmarketplaceapplications` | list, get, create, update, delete | apps |
| InventoryAsset | `inventoryassets` | list, get, create, update, delete | spaces |
| Invoice | `invoices` | list, get, update | billing |
| Language | `languages` | list, get, create, update, delete | sys |
| LanguageToken | `languagetokens` | list, get, create, update, delete | sys |
| LedgerEntry | `ledgerentries` | list, get | billing |
| LegalContentAudit | `legalcontentaudits` | list, get, create, update, delete | sys |
| LogEntry | `logentries` | list, get | sys |
| MarketPlaceApplication | `marketplaceapplications` | list, get, create, update, delete | apps |
| MsOfficeAdminCalendar | `msofficeadmincalendars` | list, get, create, update, delete | spaces |
| NewsLetter | `newsletters` | list, get, create, update, delete | content |
| NewsLetterSubscriber | `newslettersubscribers` | list, get, create, update, delete | content |
| OpenAiChatMessage | `openaichatmessages` | list, get, create, update, delete | sys |
| OpportunityType | `opportunitytypes` | list, get, create, update, delete | crm |
| PassportCard | `passportcards` | list, get, create, update, delete | sys |
| PaymentGateway | `paymentgateways` | list, get, create, update, delete | billing |
| PayoutInvoice | `payoutinvoices` | list, get, create, update, delete | sys |
| PlatformChangeMessage | `platformchangemessages` | list, get, create, update, delete | sys |
| Product | `products` | list, get, create, update, delete, commands | billing |
| ProductBookingCredit | `productbookingcredits` | list, get, create, update, delete | billing |
| ProductExtraService | `productextraservices` | list, get, create, update, delete | billing |
| ProductTimePass | `producttimepasses` | list, get, create, update, delete | billing |
| Proposal | `proposals` | list, get, create, update, delete | billing |
| ProposalContract | `proposalcontracts` | list, get, create, update, delete | billing |
| ProposalContractSchedule | `proposalcontractschedules` | list, get, create, update, delete | billing |
| ProposalProduct | `proposalproducts` | list, get, create, update, delete | billing |
| ProposalSchedule | `proposalschedules` | list, get, create, update, delete | billing |
| RadiusServer | `radiusservers` | list, get, create, update, delete | sys |
| RefreshToken | `refreshtokens` | list, get, create, update, delete | sys |
| RegisteredDevice | `registereddevices` | list, get, update | sys |
| Reminder | `reminders` | list, get, create, update, delete | crm |
| Report | `reports` | list, get, create, update, delete | sys |
| Reseller | `resellers` | list, get, create, update, delete | sys |
| ResellerAccount | `reselleraccounts` | list, get, create, update, delete | sys |
| ResellerPayout | `resellerpayouts` | list, get, create, update, delete | sys |
| Resource | `resources` | list, get, create, update, delete | spaces |
| ResourceAccessRule | `resourceaccessrules` | list, get, create, update, delete | spaces |
| ResourceAccessRuleEligibleTimeSlot | `resourceaccessruleeligibletimeslots` | list, get, create, update, delete | spaces |
| ResourceAccessRuleTimeSlot | `resourceaccessruletimeslots` | list, get, create, update, delete | spaces |
| ResourceProduct | `resourceproducts` | list, get, create, update, delete | billing |
| ResourceTimeSlot | `resourcetimeslots` | list, get, create, update, delete | spaces |
| ResourceType | `resourcetypes` | list, get, create, update, delete | spaces |
| Role | `roles` | list, get | security |
| Sensor | `sensors` | list, get, create, update, delete | sys |
| SensorHistory | `sensorhistories` | list, get, create, update, delete | sys |
| SimpleTimeZone | `simpletimezones` | list, get, update | sys |
| SubscriberActivity | `subscriberactivities` | list, get | content |
| SubscriberGroup | `subscribergroups` | list, get, create, update, delete | content |
| Survey | `surveys` | list, get, create, update, delete | content |
| SurveyAnswer | `surveyanswers` | list, get, create, update, delete | content |
| SurveyQuestion | `surveyquestions` | list, get, create, update, delete | content |
| SurveyRun | `surveyruns` | list, get, create, update, delete | content |
| SystemNotification | `systemnotifications` | list, get, create, update, delete | sys |
| Tariff | `tariffs` | list, get, create, update, delete | billing |
| TariffBookingCredit | `tariffbookingcredits` | list, get, create, update, delete | billing |
| TariffDefaultDueDate | `tariffdefaultduedates` | list, get, create, update, delete | billing |
| TariffExtraService | `tariffextraservices` | list, get, create, update, delete | billing |
| TariffProduct | `tariffproducts` | list, get, create, update, delete | billing |
| TariffSignupProduct | `tariffsignupproducts` | list, get, create, update, delete | billing |
| TariffTimePass | `tarifftimepasses` | list, get, create, update, delete | billing |
| TaskItem | `taskitems` | list, get, create, update, delete | crm |
| TaskList | `tasklists` | list, get, create, update, delete | crm |
| TaxRate | `taxrates` | list, get, create, update, delete | sys |
| Team | `teams` | list, get, create, update, delete | spaces |
| TemplateFile | `templatefiles` | list, get, create, update, delete | sys |
| TemplateVersion | `templateversions` | list, get, create, update, delete | sys |
| TimePass | `timepasses` | list, get, create, update, delete | billing |
| TimePassPrice | `timepassprices` | list, get, create, update, delete | billing |
| TimePassTimeSlot | `timepasstimeslots` | list, get, create, update, delete | billing |
| UiModule | `uimodules` | list, get, create, update, delete | sys |
| User | `users` | list, get, create, update, delete | sys |
| UserBookmark | `userbookmarks` | list, get, create, update, delete | sys |
| UserMessage | `usermessages` | list, get | sys |
| UserRole | `userroles` | list, get, create, update, delete | security |
| ValidationRule | `validationrules` | list, get, create, update, delete | sys |
| VideoFile | `videofiles` | list, get, create, update, delete | content |
| VideoRoom | `videorooms` | list, get, create, update, delete | community |
| Visitor | `visitors` | list, get, create, update, delete | spaces |
| WebHook | `webhooks` | list, get, create, update, delete | sys |
| Workspace | `workspaces` | list, get, create, update, delete | collaboration |
## Operation details
### `list`
Searches and returns a paginated list of entities. Supports `--query`, `--page`, `--size`, and `--business` filters.
### `get `
Returns full details for a single entity, including collection properties (tariffs, teams, linked resources) that are omitted from list results.
### `create`
Creates a new entity. Required fields vary by entity type — use `--help` to see them.
### `update `
Updates specific fields on an existing entity. Only the fields you supply are changed.
### `delete `
Deletes an entity. Prompts for confirmation unless `--yes` is passed.
### `commands`
Lists available special commands for the entity type (e.g., archive, activate).
### `run-command `
Executes a special command on one or more entities. Supports comma-separated IDs for batch operations.
## API pattern
Every entity maps to a Nexudus REST API endpoint following this pattern:
| Operation | HTTP Method | URL |
| ----------- | ----------- | ----------------------------------------- |
| Search | `GET` | `/api/{module}/{entities}?page=1&size=25` |
| Get one | `GET` | `/api/{module}/{entities}/{id}` |
| Create | `POST` | `/api/{module}/{entities}` |
| Update | `PUT` | `/api/{module}/{entities}` |
| Delete | `DELETE` | `/api/{module}/{entities}/{id}` |
| Commands | `GET` | `/api/{module}/{entities}/commands` |
| Run command | `POST` | `/api/{module}/{entities}/runCommand` |
**Business** entities cannot be created or deleted via the API — only listed, viewed, and updated. **Country** and **Currency** entities are
read-only (list and get only).