Skip to main content
GET
/
api
/
v1
/
rooms
List rooms for organization
curl --request GET \
  --url https://api.noux.app/api/v1/rooms \
  --header 'Authorization: Bearer <token>' \
  --header 'authorization: <authorization>'
{
  "rooms": [
    {
      "roomId": "<string>",
      "roomName": "<string>",
      "languageCode": "<string>",
      "owner": {
        "id": "<string>",
        "email": "jsmith@example.com",
        "firstName": "<string>",
        "lastName": "<string>"
      },
      "editors": [
        {
          "id": "<string>",
          "email": "jsmith@example.com",
          "firstName": "<string>",
          "lastName": "<string>"
        }
      ]
    }
  ],
  "hasMore": true,
  "total": 123,
  "pageSize": 123
}

Authorizations

Authorization
string
header
required

Noux API key from your integration settings

Headers

authorization
string
required

Bearer token with Noux API key

Query Parameters

from
string

Optional room ID to start from (inclusive). The specified room will be included in the results. Must belong to your organization.

pageSize
string

Number of rooms per page. Must be between 2 and 100. Default is 100.

Pattern: ^\d+$

Response

Rooms list retrieved successfully

rooms
object[]
required
hasMore
boolean
required

Indicates if there are more rooms available beyond the current page

total
number
required

Total number of rooms in the organization

pageSize
number
required

Number of rooms per page (as specified in the request, default 100)