Skip to main content

​
Public API Commands

The Nexudus CLI supports the Public API, which allows you to interact with your coworking space as a member rather than an administrator. This is the same API that powers the members portal, and it lets you manage your plans, bookings, invoices, visitors, and more from the command line. All public API commands use the nexudus public prefix and authenticate against a specific location’s subdomain at {webaddress}.spaces.nexudus.com.

​
How it works

The Public API targets a single location (determined by its web address/subdomain) and authenticates using member credentials (email + password). Tokens are stored separately from admin credentials, so you can switch between admin and member contexts independently. 
nexudus public <domain> <action> [options] [--json | --md | --agent]
For example: 
# Authenticate as a member
nexudus public login --web-address myspace --email you@example.com --password xxx

# List your active plans
nexudus public plans list

# View your upcoming bookings
nexudus public bookings list

# Check your invoices
nexudus public invoices list

​
Authentication

​
Log in as a member

nexudus public login --web-address myspace --email you@example.com --password your-password
OptionDescription
--web-addressThe subdomain of your location (e.g., myspace for myspace.spaces.nexudus.com)
--emailYour member email address
--passwordYour member password
--totpTwo-factor authentication code (if 2FA is enabled)
If any option is omitted, the CLI will prompt you interactively.
Public API tokens are stored separately from admin credentials. You can be logged in as both an admin and a member simultaneously.

​
Verify your session

nexudus public whoami
This displays your authenticated member information, including your email, web address, token expiry, and associated profiles.

​
Log out

nexudus public logout
This clears stored public API (member) credentials only — your admin credentials remain unaffected.

​
Command Reference

​
Business & Location

CommandDescription
nexudus public businesses currentGet current location details
nexudus public businesses networksGet all network locations
nexudus public businesses allGet all businesses in the network
nexudus public businesses withVisitorsGet locations accepting visitors
nexudus public businesses withTourGet locations with available tours
nexudus public configuration getGet mobile app configuration
nexudus public countries listGet all countries
Most business commands support the --shape option to request only specific fields: 
nexudus public businesses current --shape "Name,WebAddress,Country.Name"

​
Plans & Contracts

CommandDescription
nexudus public plans list [--cancelled]List your active or cancelled plans
nexudus public plans get <id>Get details of a specific plan
nexudus public plans publishedBrowse all published plans
nexudus public plans cancel <id>Cancel a plan contract
nexudus public contracts listList your contracts
nexudus public contracts get <id>Get contract details
nexudus public contracts pause <id>Pause a contract for N billing cycles
nexudus public contracts resume <id>Resume a paused contract
Examples: 
# List active plans
nexudus public plans list

# List cancelled plans
nexudus public plans list --cancelled

# Cancel a plan with reason
nexudus public plans cancel 12345 --reason 1 --notes "Moving to another location"

# Pause a contract for 2 billing cycles
nexudus public contracts pause 12345 --cycles 2

​
Invoices & Billing

CommandDescription
nexudus public invoices list [--paid] [--credit-notes]List your invoices
nexudus public invoices get <id>Get invoice details
nexudus public products listList your products
nexudus public discounts listList your discount codes
nexudus public discounts referralGet your referral discount codes
nexudus public discounts refer <code_id> <email>Send a referral invite
Examples: 
# List unpaid invoices
nexudus public invoices list --paid false

# List credit notes
nexudus public invoices list --credit-notes

# Send a referral invite
nexudus public discounts refer 98765 friend@example.com

​
Bookings & Resources

CommandDescription
nexudus public bookings list [--past]List your upcoming or past bookings
nexudus public bookings get <id-or-guid>Get booking details
nexudus public bookings delete <id>Cancel a booking
nexudus public bookings suggestionsGet booking suggestions
nexudus public bookings teamGet team bookings
nexudus public bookings teamCancelledGet cancelled team bookings
nexudus public bookings cancellationFeeGet cancellation fee for a booking
nexudus public resources summaryGet published resources summary
nexudus public resources detailsGet published resources with details
nexudus public resources get <id>Get specific resource details
nexudus public resources products <id>Get products for a resource
nexudus public resources fields <id>Get custom fields for a resource
Examples: 
# List upcoming bookings
nexudus public bookings list

# List past bookings
nexudus public bookings list --past

# Cancel a booking
nexudus public bookings delete 12345 --reason "NoLongerNeeded" --details "Meeting was rescheduled"

# Browse available resources
nexudus public resources summary

​
Visitors

CommandDescription
nexudus public visitors list [--past]List your upcoming or past visitors
nexudus public visitors get <id>Get visitor details
nexudus public visitors createCreate a new visitor
nexudus public visitors delete <id>Delete a visitor
nexudus public visitors approve <id>Approve or reject a visitor
Examples: 
# List upcoming visitors
nexudus public visitors list

# Create a visitor
nexudus public visitors create --business-id 12345 --full-name "John Doe" --email "john@example.com" --expected-arrival "2026-07-10T10:00:00"

# Create visitors from a JSON file
nexudus public visitors create --json-file visitors.json

# Approve a visitor
nexudus public visitors approve 12345

​
Profile & Settings

CommandDescription
nexudus public profile patchUpdate your profile
nexudus public coworkers profilesGet all your profiles across locations
nexudus public coworkers benefitsGet your benefits (credits, passes)
nexudus public coworkers setCurrentSet your active profile
nexudus public settings get <name>Get a specific setting value
nexudus public settings getMultiple <names>Get multiple setting values
nexudus public settings search <query>Search settings
nexudus public settings set <name> <value>Set a setting value
nexudus public settings setMultipleSet multiple settings at once
Examples: 
# Update your profile
nexudus public profile patch --json-request '{"User":{"FirstName":"John"},"Coworker":{"Phone":"555-0100"}}'

# Check your benefits
nexudus public coworkers benefits

# Get a specific setting
nexudus public settings get "maxBookingDays"

​
Store & Checkout

CommandDescription
nexudus public store listBrowse store products
nexudus public store get <id>Get store product details
nexudus public checkout previewPreview checkout with basket items
nexudus public signup contactSend a contact form message
Examples: 
# Browse store products
nexudus public store list

# Filter to time passes only
nexudus public store list --only-time-passes

# Filter by tag
nexudus public store list --tag "printing"

# Preview checkout
nexudus public checkout preview --basket '[{"ProductId":123,"Quantity":1}]' --agreed-terms

​
Community

CommandDescription
nexudus public community threads listList community threads
nexudus public community threads get <id>Get thread details
nexudus public community threads startStart a new thread
nexudus public community threads delete <id>Delete a thread
nexudus public community threads like <id>Like a thread
nexudus public community threads follow <id>Follow a thread
nexudus public community threads messages list <id>List thread messages
nexudus public community threads messages replyReply to a thread
nexudus public community threads messages likeLike a message
nexudus public community groups listList community groups
nexudus public community tags listList thread tags
Examples: 
# List community threads
nexudus public community threads list

# Start a new thread
nexudus public community threads start --subject "Welcome event this Friday" --message "Join us for drinks and networking!" --tags "events,community"

# Like a thread
nexudus public community threads like 12345

​
Perks

CommandDescription
nexudus public perks listList available perks
nexudus public perks claim <perk-id>Claim a perk

​
Blog & Content

CommandDescription
nexudus public blog list [--category-id] [--search] [--featured]List blog posts
nexudus public blog get <id>Get a blog post
nexudus public blog categoriesList blog categories
nexudus public events list [--past] [--category-id] [--featured]List events
nexudus public events get <id>Get event details
nexudus public faq list [--search]List FAQ articles
nexudus public newsletter subscribe <email>Subscribe to newsletter
Examples: 
# Browse blog posts
nexudus public blog list

# Search blog posts
nexudus public blog list --search "workshop"

# List upcoming events
nexudus public events list

# Subscribe to newsletter
nexudus public newsletter subscribe you@example.com --name "John Doe"

​
Courses

CommandDescription
nexudus public courses list [--group] [--search]List available courses
nexudus public courses get <id>Get course details
nexudus public courses myList your enrolled courses
nexudus public courses signup <id>Sign up for a course
nexudus public courses accept <id>Accept a course invitation
nexudus public courses lessons <id>List course lessons
nexudus public courses lesson get <id>Get lesson details
nexudus public courses lesson complete <id>Mark a lesson as complete

​
Help Desk

CommandDescription
nexudus public helpdesk messages listList your help desk messages
nexudus public helpdesk messages get <id>Get message details
nexudus public helpdesk messages createCreate a new help desk message
nexudus public helpdesk messages close <id>Close a message
nexudus public helpdesk comments list <id>List comments on a message
nexudus public helpdesk comments createAdd a comment
nexudus public helpdesk departments listList help desk departments

​
Teams

CommandDescription
nexudus public teams myList your teams
nexudus public teams profile <id>Get team profile
nexudus public teams publishedBrowse published teams
nexudus public teams publishedGet <id>Get published team details
nexudus public teams addMembers <id>Add members to a team
nexudus public teams removeMember <id>Remove a member from a team
nexudus public teams attendance <id>Get team attendance
nexudus public teams kpi <id>Get team KPIs
nexudus public teams metrics <id>Get team metrics
nexudus public teams directoryMetaGet team directory metadata

​
Deliveries & Mail

CommandDescription
nexudus public deliveries list [--show-pending]List your deliveries
nexudus public delivery get <id>Get delivery details
nexudus public delivery update <id>Update delivery info
nexudus public delivery markCollected <id>Mark a delivery as collected

​
Virtual Offices

CommandDescription
nexudus public vo metaGet virtual office metadata
nexudus public vo form getGet the virtual office form
nexudus public vo form submitSubmit the virtual office form
nexudus public vo amlChecks listList AML checks
nexudus public vo amlChecks startStart an AML check
nexudus public vo identityChecks listList identity checks
nexudus public vo identityChecks startStart an identity check
nexudus public vo directors listList company directors
nexudus public vo directors addAdd a company director
nexudus public vo recipients listList mail recipients
nexudus public vo recipients addAdd a mail recipient
nexudus public vo companyAliases listList company aliases
nexudus public vo companyAliases addAdd a company alias
CommandDescription
nexudus public identityChecks listList your identity checks
nexudus public identityChecks get <id>Get identity check details
nexudus public identityChecks upload <id>Upload identity documents
nexudus public legal statusCheck terms acceptance status
nexudus public legal acceptAccept terms and conditions
Examples: 
# Check if you've accepted terms
nexudus public legal status

# Accept general terms
nexudus public legal accept --general

# Accept both general and contract terms
nexudus public legal accept --all

​
Forms & Surveys

CommandDescription
nexudus public form get <id>Get a form page
nexudus public form preview <id>Preview a form
nexudus public form submit <id>Submit a form
nexudus public survey questionnaire <id>Get a survey questionnaire
nexudus public survey preview <id>Preview a survey
nexudus public survey submit <id>Submit survey answers

​
Onboarding & Data Files

CommandDescription
nexudus public onboarding getGet onboarding actions
nexudus public dataFiles listList your data files
nexudus public dataFiles getFileUrl <id>Get file download URL
nexudus public dataFiles getSignedUrl <id>Get signed URL for a file
nexudus public dataFiles eSignStatus <id>Get e-signature status

​
Payments

CommandDescription
nexudus public payments stripe createCustomerSessionCreate a Stripe payment session
nexudus public payments stripe createSetupSessionCreate a Stripe setup session
nexudus public payments paypal createCustomerSessionCreate a PayPal customer session
nexudus public payments paypal createGuestSessionCreate a PayPal guest session
nexudus public payments spreedly createCustomerSessionCreate a Spreedly session
nexudus public payments spreedly storePaymentMethodStore a Spreedly payment method

​
Response Shaping

Many public API endpoints support response shaping via the --shape option. This lets you request only the fields you need, reducing response size and improving performance. 
# Full response
nexudus public plans list

# Only specific fields
nexudus public plans list --shape "Name,Price,FromTime"

# Nested fields using dot notation
nexudus public businesses current --shape "Name,WebAddress,Country.Name,Currency.Code"
Not all commands support --shape. It’s available on commands that wrap endpoints with response shaping support (most list and get operations).

​
Global Flags

All public API commands support the same global flags as admin commands:
FlagDescription
--jsonOutput raw JSON (for scripting)
--mdOutput as Markdown tables
--agentOutput structured JSON envelope (for AI assistants)
--web-address <addr>Override the location subdomain

​
Error Handling

​
Common Errors

ErrorCauseSolution
”Not logged in (public)“No public API token storedRun nexudus public login
”Unauthorized”Token expired or invalidRun nexudus public login again
”Two-factor authentication required”2FA is enabled on your accountUse --totp to provide your code
”Account locked”Too many failed login attemptsWait and retry, or reset your password
”Account disabled”Account has been disabledContact your space administrator
”Must reset password”Password reset requiredUse “Forgot password” on the members portal

​
Next steps

Install the CLI

Download and set up the Nexudus CLI on your machine.

Admin Commands

Browse the full reference of admin CLI commands.