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.
URL Parameters Reference
You can link directly into specific Members Portal pages with pre-filled values by appending URL parameters. This is useful when sending customers to your portal from external websites, emails, marketing campaigns, or automation workflows.
All query parameters are appended to the URL after a ? character, and multiple parameters are separated with &. For example:
https://your-portal.nexudus.com/bookings/meeting-rooms/list?start=2026-06-01T09:00:00&type=12345
Booking pages
Resource list and calendar
Path: /bookings/:type/:view
Use this to send customers directly to a filtered view of bookable resources.
| Parameter | Location | Description |
|---|
:type | Path | Resource type slug (e.g. meeting-rooms, hot-desks, all) |
:view | Path | View mode: list, calendar, map, or floorplan |
start | Query | Start date/time in ISO 8601 format (e.g. 2026-06-01T09:00:00) |
end | Query | End date/time in ISO 8601 format |
view | Query | Calendar sub-view: day, week, month, or list |
type | Query | Filter by resource type ID |
group | Query | Filter by resource group name |
Allocation | Query | Minimum capacity (number of persons) |
floorplan_id | Query | Floor plan ID (for the floorplan view) |
customFields | Query | Comma-separated custom field filters |
true to filter resources by amenities:
Projector, Internet, ConferencePhone, StandardPhone, WhiteBoard, LargeDisplay, Catering, TeaAndCoffee, Drinks, SecurityLock, CCTV, VoiceRecorder, AirConditioning, Heating, NaturalLight, StandingDesk, QuietZone, WirelessCharger, PrivacyScreen
Example: Show meeting rooms with a projector and natural light in calendar week view:
/bookings/meeting-rooms/calendar?view=week&Projector=true&NaturalLight=true
Booking checkout
Path: /public/bookings/edit
Use this to send customers directly to the booking form for a specific resource.
| Parameter | Location | Description |
|---|
resource_id | Query | ID of the resource to book |
start | Query | Booking start time in ISO 8601 format |
end | Query | Booking end time in ISO 8601 format |
desk | Query | Specific desk ID (for resources with desk-level booking) |
booking | Query | Existing booking ID (to edit an existing booking) |
id | Query | Alternative parameter for existing booking ID |
Example: Open a booking form for resource 12345 on June 1st at 2pm:
/public/bookings/edit?resource_id=12345&start=2026-06-01T14:00:00&end=2026-06-01T15:00:00
Checkout and sign-up
Plan selection and sign-up flow
Path: /checkout/tariffs
Use this to send prospective customers directly to the sign-up flow, optionally with a plan pre-selected.
| Parameter | Location | Description |
|---|
plan_id | Query | Pre-select a specific plan by ID |
start | Query | Contract start date in ISO 8601 date format (e.g. 2026-06-01) |
invite_guid | Query | Invitation GUID to reveal restricted/private plans |
team_guid | Query | Team GUID for team-based sign-up |
proposal_id | Query | Proposal ID for proposal-based checkout |
discountCode | Query | Pre-apply a discount code |
refererGuid | Query | Referrer GUID for referral tracking |
type | Query | Filter visible plans by plan type number |
session_id | Query | AI assistant session ID to track the conversation that led to this checkout |
Example: Send a customer to sign up with plan 67890 and a discount code:
/checkout/tariffs?plan_id=67890&discountCode=SUMMER20
utm_source, utm_medium, utm_campaign, utm_term, utm_content
Checkout invite
Path: /checkout/invite
| Parameter | Location | Description |
|---|
t | Query | Invite token — stored locally and used to unlock restricted plans |
Store and products
Product store
Path: /store/:type
| Parameter | Location | Description |
|---|
:type | Path | Product type slug to filter by, or all to show everything |
Product checkout
Path: /product/edit
| Parameter | Location | Description |
|---|
product_id | Query | ID of the product to purchase |
Example: Link directly to purchase product 11111:
/product/edit?product_id=11111
Events
Events list and calendar
Path: /events/:view or /events/:view/:categoryId/:slug
| Parameter | Location | Description |
|---|
:view | Path | View mode: list or calendar |
:categoryId | Path | Category ID to filter events |
:slug | Path | Category slug (for SEO-friendly URLs) |
page | Query | Page number for pagination |
past | Query | Set to true to show past events |
search | Query | Search term to filter events |
start | Query | Calendar start date in ISO 8601 format |
end | Query | Calendar end date in ISO 8601 format |
date | Query | Selected date in ISO 8601 format |
Event details
Path: /events/view/:id/:slug
| Parameter | Location | Description |
|---|
:id | Path | Event ID |
:slug | Path | Event name slug (for SEO-friendly URLs) |
Event checkout
Path: /event/edit
| Parameter | Location | Description |
|---|
event_id | Query | ID of the event to register for |
attendees | Query | Number of attendees to pre-fill |
Example: Register for event 22222 with 3 attendees:
/event/edit?event_id=22222&attendees=3
Courses
Course details
Path: /courses/view/:id/:slug
| Parameter | Location | Description |
|---|
:id | Path | Course ID |
:slug | Path | Course title slug (for SEO-friendly URLs) |
Course checkout
Path: /course/edit
| Parameter | Location | Description |
|---|
course_id | Query | ID of the course to enrol in |
Path: /community/board
| Parameter | Location | Description |
|---|
group | Query | Group ID to filter threads |
inbox | Query | Show inbox threads |
tag | Query | Tag to filter by |
thread_id | Query | Open a specific thread |
Members directory
Path: /community/directory
| Parameter | Location | Description |
|---|
coworker_id | Query | Show a specific customer’s profile |
team_id | Query | Show a specific team’s profile |
tag | Query | Filter by skill or tag |
search | Query | Search term |
type | Query | Filter type |
order | Query | Sort order |
Locations directory
Path: /directory
| Parameter | Location | Description |
|---|
maplat | Query | Map centre latitude |
maplng | Query | Map centre longitude |
mapzoom | Query | Map zoom level |
#card-{id} to auto-scroll to a specific location card.
Path: /enquire/form
| Parameter | Location | Description |
|---|
plan_id | Query | Pre-select a plan for the enquiry |
invite_guid | Query | Invitation GUID |
team_guid | Query | Team GUID |
proposal_id | Query | Proposal ID |
discountCode | Query | Pre-apply a discount code |
refererGuid | Query | Referrer GUID |
Tour request
Path: /:webAddress (location home page)
| Parameter | Location | Description |
|---|
action | Query | Set to tour to open the tour request form |
summary | Query | Pre-fill tour notes |
Example: Open the tour form with a note:
/your-space?action=tour&summary=Interested+in+a+10-person+office
FAQ
Path: /user/faq
| Parameter | Location | Description |
|---|
faq_id | Query | Auto-open a specific FAQ article |
category | Query | Filter by category name |
Authentication
Login
Path: /login
| Parameter | Location | Description |
|---|
redirectTo | Query | URL path to redirect to after login |
redirectUrl | Query | Alternative redirect parameter |
t | Query | Exchange token for automatic login |
Example: Send a customer to login and then redirect to a booking page:
/login?redirectTo=%2Fpublic%2Fbookings%2Fedit%3Fresource_id%3D12345
Password reset
Path: /login/forgot-reset
| Parameter | Location | Description |
|---|
token | Query | Password reset JWT token |
Form pages
Path: /forms/:formId/show
| Parameter | Location | Description |
|---|
:formId | Path | Form GUID |
Survey pages
Path: /survey/:surveyId/questionnaire
| Parameter | Location | Description |
|---|
:surveyId | Path | Survey GUID |
Notes
- Path parameters (marked with
:) are part of the URL path itself and are required.
- Query parameters are appended after
? and are optional unless noted otherwise.
- All IDs refer to the Nexudus record ID, which you can find in the admin dashboard URL or via the REST API.
- Dates use ISO 8601 format:
YYYY-MM-DDTHH:mm:ss for date-times, YYYY-MM-DD for dates.
- URL-encode any special characters in parameter values (spaces become
+ or %20).
