List rooms
Lists the project’s reusable Video Rooms for SDK-based video experiences. Use Get room when you already have a room ID, or Get room by name when your application stores the room’s unique name.
Permissions
The API token used to authenticate must have the following scope(s) enabled to make a successful request: Video.
Authentication
SignalWire Basic Authentication using Project ID and API Token.
The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.
Example:
Authorization: Basic base64(project_id:token)
Query parameters
Specifies whether or not to include information about the room’s active session (if any).
Return rooms with a join_from date on or after this date. Expects RFC 3339 datetime or date string.
Return rooms with a join_until date on or before this date. Expects RFC 3339 datetime or date string.
Page number to return. Requires page_token for values greater than 0.
Specify the number of results to return on a single page. The default page size is 50 and the maximum is 1000.
Token for cursor-based pagination. Required when page_number is greater than 0.