Entity Reference
The Nexudus CLI supports 40+ 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 | security |
| 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 | billing |
| BookingVisitor | bookingvisitors | list, get, create, update, delete | spaces |
| Business | businesses | list, get, update | sys |
| CancelledBooking | cancelledbookings | list, get | spaces |
| Checkin | checkins | list, get, create, update, delete | spaces |
| Country | countries | list, get | sys |
| Coworker | coworkers | list, get, create, update, delete, commands | spaces |
| CoworkerDelivery | coworkerdeliveries | 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 |
| CoworkerNotification | coworkernotifications | list, get, create, update, delete | spaces |
| CoworkerPricePlanHistory | coworkerpriceplanhistories | list, get | billing |
| Currency | currencies | list, get | sys |
| ExtraService | extraservices | list, get, create, update, delete | billing |
| FailedCheckin | failedcheckins | list, get | spaces |
| InventoryAsset | inventoryassets | list, get, create, update, delete | spaces |
| MsOfficeAdminCalendar | msofficeadmincalendars | list, get, create, update, delete | spaces |
| Product | products | list, get, create, update, delete, commands | billing |
| ProductExtraService | productextraservices | list, get, create, update, delete | billing |
| ProductTimePass | producttimepasses | list, get, create, update, delete | billing |
| 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 |
| ResourceTimeSlot | resourcetimeslots | list, get, create, update, delete | spaces |
| ResourceType | resourcetypes | list, get, create, update, delete | spaces |
| Team | teams | list, get, create, update, delete | spaces |
| TimePass | timepasses | list, get, create, update, delete | billing |
| Visitor | visitors | list, get, create, update, delete | spaces |
Operation details
list
Searches and returns a paginated list of entities. Supports --query, --page, --size, and --business filters.
get <id>
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 <id>
Updates specific fields on an existing entity. Only the fields you supply are changed.
delete <id>
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 <command> <id>
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).