Skip to navigation

List rooms

View as Markdown

List rooms. Results are newest first by created_at.

This endpoint uses an optional limit, not cursor pagination. Omit limit to return every room. If limit truncates the result, has_more is true. The system result ceiling is evaluated before limit, so limit cannot prevent a 413 response when the full result set exceeds that ceiling.

Authentication

AuthorizationBearer

Send Authorization: Bearer <app_uuid>:<api_key> using an active API key. See Authentication for details.

Query parameters

limitintegerOptional>=1

Optional cap on the number of rooms to return. Omit to return every room (never clamped); when set, at most this many are returned. A non-positive value returns 400.

Response headers

traceparentstringOptionalformat: "^00-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-f]{2}$"=55 characters

Server-owned W3C Trace Context for correlating this response with support and observability data. It is present on successful and error responses. A valid incoming traceparent is linked to, but never becomes, the server-owned trace identifier.

Response

Rooms
has_moreboolean

true when more rooms matched than limit allowed; raise limit to retrieve all of them.

roomslist of objects

Errors

400
Bad Request Error
401
Unauthorized Error
406
Not Acceptable Error
413
Content Too Large Error
429
Too Many Requests Error
500
Internal Server Error