REST API for Nexus Hospitality
Every HTTP endpoint the application exposes, grouped by resource.
Calling the API
The API is served from the same address as the application, under /api. Requests carry the session cookie issued at sign-in, so a browser session and an API call are the same identity and obey the same permissions.
Every state changing request (POST, PUT, PATCH, DELETE) must also carry this application family's presence header, or it is refused with
403 bad request. That refusal reads like a permissions fault but is not one.
Integration and APIs lists the header per family.
Endpoints
158 endpoints in 50 resource groups.
activity · availability · billing · butler · butlers · channels · companies · concierge · connect · custom-domain · dashboard · experience-bookings · experiences · folios · frontdesk · g · glitches · glogin · glogout · groups · guests · health · housekeeping · login · logout · me · messages · next-number · nightaudit · nxdocs · nxdocs-file · nxtz · perms · portfolio · pos · properties · rate-plans · reports · reservations · revenue · roles · room-types · rooms · search · service-requests · sso · transfers · username · users · work-orders
activity 1
| Method | Path | Access |
|---|
| GET | /api/activity | administrator |
availability 1
| Method | Path | Access |
|---|
| GET | /api/availability | signed in |
billing 2
| Method | Path | Access |
|---|
| GET | /api/billing/folios | signed in |
| GET | /api/billing/open | signed in |
butler 1
| Method | Path | Access |
|---|
| GET | /api/butler | signed in |
butlers 1
| Method | Path | Access |
|---|
| GET | /api/butlers | signed in |
channels 3
| Method | Path | Access |
|---|
| GET | /api/channels | signed in |
| POST | /api/channels | administrator |
| POST | /api/channels/:id/sync | signed in |
companies 2
| Method | Path | Access |
|---|
| GET | /api/companies | signed in |
| POST | /api/companies | signed in |
concierge 1
| Method | Path | Access |
|---|
| GET | /api/concierge | signed in |
connect 25
| Method | Path | Access |
|---|
| GET | /api/connect/connections | signed in |
| POST | /api/connect/connections | signed in |
| DELETE | /api/connect/connections/:id | signed in |
| PUT | /api/connect/connections/:id | signed in |
| POST | /api/connect/connections/:id/call | signed in |
| POST | /api/connect/connections/:id/test | signed in |
| GET | /api/connect/hooks | signed in |
| POST | /api/connect/hooks | signed in |
| DELETE | /api/connect/hooks/:id | signed in |
| PUT | /api/connect/hooks/:id | signed in |
| GET | /api/connect/hooks/:id/events | signed in |
| GET | /api/connect/log | signed in |
| GET | /api/connect/meta | signed in |
| GET | /api/connect/subs | signed in |
| POST | /api/connect/subs | signed in |
| DELETE | /api/connect/subs/:id | signed in |
| PUT | /api/connect/subs/:id | signed in |
| POST | /api/connect/subs/:id/test | administrator |
| GET | /api/connect/tokens | signed in |
| POST | /api/connect/tokens | signed in |
| DELETE | /api/connect/tokens/:id | signed in |
| PUT | /api/connect/tokens/:id | signed in |
| POST | /connect/hook/:slug | signed in |
| GET | /connect/mcp | signed in |
| POST | /connect/mcp | signed in |
custom-domain 3
| Method | Path | Access |
|---|
| GET | /api/custom-domain | signed in |
| PUT | /api/custom-domain | administrator |
| POST | /api/custom-domain/verify | administrator |
dashboard 1
| Method | Path | Access |
|---|
| GET | /api/dashboard | signed in |
experience-bookings 3
| Method | Path | Access |
|---|
| GET | /api/experience-bookings | signed in |
| POST | /api/experience-bookings | signed in |
| POST | /api/experience-bookings/:id/status | signed in |
experiences 3
| Method | Path | Access |
|---|
| GET | /api/experiences | administrator |
| POST | /api/experiences | administrator |
| PUT | /api/experiences/:id | administrator |
folios 5
| Method | Path | Access |
|---|
| GET | /api/folios/:id | signed in |
| POST | /api/folios/:id/charge | signed in |
| POST | /api/folios/:id/gateway-payment | signed in |
| POST | /api/folios/:id/payment | signed in |
| POST | /api/folios/:id/void/:itemId | administrator |
frontdesk 1
| Method | Path | Access |
|---|
| GET | /api/frontdesk | signed in |
g 9
| Method | Path | Access |
|---|
| POST | /api/g/checkin | signed in |
| GET | /api/g/experiences | signed in |
| POST | /api/g/experiences | signed in |
| GET | /api/g/key | signed in |
| GET | /api/g/me | signed in |
| GET | /api/g/messages | signed in |
| POST | /api/g/messages | signed in |
| POST | /api/g/pay | signed in |
| POST | /api/g/request | signed in |
glitches 3
| Method | Path | Access |
|---|
| GET | /api/glitches | signed in |
| POST | /api/glitches | signed in |
| POST | /api/glitches/:id/resolve | signed in |
glogin 1
| Method | Path | Access |
|---|
| POST | /api/glogin | signed in |
glogout 1
| Method | Path | Access |
|---|
| POST | /api/glogout | signed in |
groups 2
| Method | Path | Access |
|---|
| GET | /api/groups | signed in |
| POST | /api/groups | signed in |
guests 4
| Method | Path | Access |
|---|
| GET | /api/guests | signed in |
| POST | /api/guests | signed in |
| GET | /api/guests/:id | signed in |
| PUT | /api/guests/:id | signed in |
health 1
| Method | Path | Access |
|---|
| GET | /api/health | signed in |
housekeeping 3
| Method | Path | Access |
|---|
| GET | /api/housekeeping | signed in |
| POST | /api/housekeeping/tasks | signed in |
| POST | /api/housekeeping/tasks/:id/done | signed in |
login 2
| Method | Path | Access |
|---|
| POST | /api/login | public |
| POST | /api/login/2fa | public |
logout 1
| Method | Path | Access |
|---|
| POST | /api/logout | signed in |
me 4
| Method | Path | Access |
|---|
| GET | /api/me | signed in |
| POST | /api/me/password | signed in |
| GET | /api/me/profile | signed in |
| PUT | /api/me/profile | signed in |
messages 3
| Method | Path | Access |
|---|
| GET | /api/messages | signed in |
| GET | /api/messages/:rid | signed in |
| POST | /api/messages/:rid | signed in |
next-number 1
| Method | Path | Access |
|---|
| GET | /api/next-number | signed in |
nightaudit 2
| Method | Path | Access |
|---|
| GET | /api/nightaudit | signed in |
| POST | /api/nightaudit/run | administrator |
nxdocs 2
| Method | Path | Access |
|---|
| GET | /api/nxdocs/:kind/:ref | signed in |
| POST | /api/nxdocs/:kind/:ref | signed in |
nxdocs-file 2
| Method | Path | Access |
|---|
| DELETE | /api/nxdocs-file/:id | signed in |
| GET | /api/nxdocs-file/:id | signed in |
nxtz 3
| Method | Path | Access |
|---|
| GET | /api/nxtz | signed in |
| PUT | /api/nxtz | signed in |
| POST | /api/nxtz/device | signed in |
perms 2
| Method | Path | Access |
|---|
| GET | /api/perms/catalog | signed in |
| GET | /api/perms/resolved | administrator |
portfolio 1
| Method | Path | Access |
|---|
| GET | /api/portfolio | signed in |
pos 7
| Method | Path | Access |
|---|
| GET | /api/pos | signed in |
| POST | /api/pos/checks | signed in |
| GET | /api/pos/checks/:id | signed in |
| POST | /api/pos/checks/:id/items | signed in |
| POST | /api/pos/checks/:id/settle | signed in |
| POST | /api/pos/menu | administrator |
| POST | /api/pos/outlets | administrator |
properties 3
| Method | Path | Access |
|---|
| GET | /api/properties | signed in |
| POST | /api/properties | administrator |
| PUT | /api/properties/:id | administrator |
rate-plans 3
| Method | Path | Access |
|---|
| GET | /api/rate-plans | administrator |
| POST | /api/rate-plans | administrator |
| PUT | /api/rate-plans/:id | administrator |
reports 1
| Method | Path | Access |
|---|
| GET | /api/reports | signed in |
reservations 11
| Method | Path | Access |
|---|
| GET | /api/reservations | signed in |
| POST | /api/reservations | signed in |
| GET | /api/reservations/:id | signed in |
| PUT | /api/reservations/:id | signed in |
| POST | /api/reservations/:id/assign | signed in |
| POST | /api/reservations/:id/butler | signed in |
| POST | /api/reservations/:id/cancel | signed in |
| POST | /api/reservations/:id/checkin | signed in |
| POST | /api/reservations/:id/checkout | signed in |
| POST | /api/reservations/:id/extend | signed in |
| POST | /api/reservations/:id/move | signed in |
revenue 2
| Method | Path | Access |
|---|
| GET | /api/revenue | signed in |
| POST | /api/revenue/adjust | administrator |
roles 5
| Method | Path | Access |
|---|
| GET | /api/roles | administrator |
| POST | /api/roles | administrator |
| DELETE | /api/roles/:id | administrator |
| PUT | /api/roles/:id | administrator |
| GET | /api/roles/:id/users | administrator |
room-types 3
| Method | Path | Access |
|---|
| GET | /api/room-types | signed in |
| POST | /api/room-types | administrator |
| PUT | /api/room-types/:id | administrator |
rooms 4
| Method | Path | Access |
|---|
| GET | /api/rooms | signed in |
| POST | /api/rooms | administrator |
| PUT | /api/rooms/:id | signed in |
| POST | /api/rooms/:id/status | signed in |
search 2
| Method | Path | Access |
|---|
| GET | /api/search | signed in |
| GET | /api/search/coverage | signed in |
service-requests 4
| Method | Path | Access |
|---|
| GET | /api/service-requests | signed in |
| POST | /api/service-requests | signed in |
| POST | /api/service-requests/:id/assign | signed in |
| POST | /api/service-requests/:id/status | signed in |
sso 1
| Method | Path | Access |
|---|
| POST | /api/sso/accounts | signed in |
transfers 3
| Method | Path | Access |
|---|
| GET | /api/transfers | signed in |
| POST | /api/transfers | signed in |
| POST | /api/transfers/:id/status | signed in |
username 1
| Method | Path | Access |
|---|
| POST | /api/username/forgot | public |
users 5
| Method | Path | Access |
|---|
| GET | /api/users | administrator |
| POST | /api/users | administrator |
| PUT | /api/users/:id | administrator |
| GET | /api/users/:id/roles | administrator |
| PUT | /api/users/:id/roles | administrator |
work-orders 3
| Method | Path | Access |
|---|
| GET | /api/work-orders | signed in |
| POST | /api/work-orders | signed in |
| POST | /api/work-orders/:id/resolve | signed in |
© 2026 Nexus SoftSphere LLC. All rights reserved. Nexus SoftSphere is the author and owner of this documentation.
