Skip to main content
The Noux REST API lets your applications and automation workflows create rooms, manage materials, sync data, and build custom integrations.

​
Base URL

All API requests use:

​
Authentication

Authenticate with a Bearer token using your Noux API key:
Create and manage API keys in the Noux app under Integrations → API.

​
Room and template rooms

Room list and detail endpoints (GET /api/v1/rooms, GET /api/v1/room/{id}) return a template boolean on each room. When template is true, the item is a template room rather than a sales room. The total count on GET /api/v1/rooms includes both sales rooms and templates. Endpoints that embed linked room context (notetaker meetings, e-sign bundles) include roomTemplate (nullable boolean) when a room is linked.

​
Quick send

Quick send turns a configured room template plus invitation copy into a one-call automation. Your organization builds the sets on the Automation page in Noux; the API only picks a set, an option, and the people to invite. Because room creation runs in the background, POST /api/v1/quick-send/trigger responds with 202 Accepted and a trigger id:
  1. GET /api/v1/quick-send/sets — list the sets enabled for the API and their options.
  2. POST /api/v1/quick-send/trigger — send setId, optionId, and invitees.
  3. GET /api/v1/quick-send/trigger/{id} — poll until status is RoomCreated and read roomId.
The room owner configured on the option becomes the room’s creator and owner and receives a notification email with a link to the room. The API is an internal surface, so you may always pass a schedule to send invitations later; invitations go out immediately when you omit it.

​
Getting started

  1. Create an API key in your Noux organization settings.
  2. Browse the Reference section in the sidebar for endpoint details and the interactive playground.
  3. Test requests against the production API using your key.