Skip to content
Docs
English
EnglishDeutschNot translatedEspañolNot translated
Esc
↑↓navigate↵open⌘Jpreview

List rooms

Returns a cursor-paginated list. Scoped to your integration’s institution via Basic Auth credentials.

GET/rooms
Authorization
AuthorizationBasic auth · headerrequired

Basic Auth with clientId as username and clientSecret as password

Query parameters
cursorstring
limitinteger
default: 10
searchstring
Responses
200

List of rooms

dataRoom[]required
Show properties
Array of Room
idstringrequired
namestringrequired
institutionIdstringrequired
personCapacityintegerrequired
addressNotesstringrequired

Additional address notes. Empty string when not set.

codestring | null
locationIdstring | null
statusstringrequired
Allowed:ACTIVEMAINTENANCEINACTIVE
isOnlinebooleanrequired
onlineLinkstring | null
locationLocationSummary | null
Show properties
One of:
LocationSummary
idstringrequired
namestringrequired

Display name for the location — the label shown in the dashboard when managing rooms and assigning them to a site (e.g. Main Campus, North Building, Sleeping Pod Area).

max length 100
addressstringrequired

Physical street or postal address of the location. Used in the dashboard for map display and geocoding — provide a real-world address, not the location name repeated (e.g. 123 University Ave, 10115 Berlin).

max length 500
institutionIdstringrequired
null
null
_countobjectrequired

Counts of linked courses, modules, scheduled status changes, and equipment/amenities.

Show properties
coursesintegerrequired
modulesintegerrequired
scheduledChangesintegerrequired
equipmentAndAmenitiesintegerrequired
paginationCursorPaginationrequired
Show properties
next_cursorstring | nullrequired
has_morebooleanrequired
limitintegerrequired
metaResponseMetarequired
Show properties
requestIdstringrequired
timestampstring<date-time>required
versionstringrequired
Allowed:v4
401

Unauthorized

typestringrequired
Allowed:error
codestringrequired
Allowed:bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedrate_limit_exceededinternal_error
titlestringrequired
statusintegerrequired
detailstringrequired
instancestring
errorsobject[]
Show properties
Array of object
fieldstring
messagestring
429

Too Many Requests

typestringrequired
Allowed:error
codestringrequired
Allowed:bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedrate_limit_exceededinternal_error
titlestringrequired
statusintegerrequired
detailstringrequired
instancestring
errorsobject[]
Show properties
Array of object
fieldstring
messagestring
500

Internal Server Error

typestringrequired
Allowed:error
codestringrequired
Allowed:bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedrate_limit_exceededinternal_error
titlestringrequired
statusintegerrequired
detailstringrequired
instancestring
errorsobject[]
Show properties
Array of object
fieldstring
messagestring
Try it
Server
Authorization
Parameters
Request
curl -X GET 'https://fuxam.app/api/v4/rooms' \
  -H 'Authorization: Basic YOUR_CREDENTIALS'
Response
{
  "data": [
    {
      "id": "room_001",
      "name": "Lecture Hall A",
      "institutionId": "inst_123",
      "personCapacity": 120,
      "addressNotes": "",
      "code": "LHA",
      "locationId": "loc_001",
      "status": "ACTIVE",
      "isOnline": false,
      "onlineLink": null,
      "location": {
        "id": "loc_001",
        "name": "Main Campus",
        "address": "123 University Ave",
        "institutionId": "inst_123"
      },
      "_count": {
        "courses": 1,
        "modules": 1,
        "scheduledChanges": 1,
        "equipmentAndAmenities": 1
      }
    }
  ],
  "pagination": {
    "next_cursor": null,
    "has_more": false,
    "limit": 10
  },
  "meta": {
    "requestId": "req_abc123",
    "timestamp": "2026-06-26T00:00:00.000Z",
    "version": "v4"
  }
}