Get Rooms API

The Get Rooms API provides the ability to fetch all the rooms that were created using the create room API. In order to use the API, you will need to obtain an API key by connecting to your wallet.



Whatever rooms were created using the given API key will be returned in the response. The API supports pagination and will return 10 rooms per page. The response will also contain a cursor which can be used to fetch the next set of rooms.


Get Rooms API

The API supports a GET request with the following required parameters:

  • x-api-key - Add your API Key to the headers to fetch all rooms associated with your API Key.
GET • /get-rooms
const response = await axios.get(
    headers: {
      'Content-Type': 'application/json',
      'x-api-key': {{API_KEY}},

Upon success, the API will return a response with an array of rooms with the following fields:

  • nextCursor - The next page number
  • prevCursor - The previous page number
  • current - The current page number
  • total - The total number of rooms returned
  • rooms - The list of rooms with their respective roomId, meetingLink, startTime, endTime and roomType.

In case of an error, the API will return an error message with a corresponding status code.

      "nextCursor": 1,
      "prevCursor": 0,
      "count": 1,
      "rooms": [
            "roomId": "dummy-room-id",
            "meetingUrl": "",
            "startTime": null,
            "expiryTime": null,
            "roomType": "VIDEO"
Audio/Video Infrastructure designed for the developers to empower them ship simple yet powerful Audio/Video Apps.
Copyright © 2024 Graphene 01, Inc. All Rights Reserved.