Skip to main content

List rooms

Summary

  • Request all rooms in order to populate a dropdown menu for room selection
  • Required API calls: roomService/list

Request

Request to https://apis.alfaview.com/json/v1/roomService/list

{
  "accessInfo": {
    "requestId": "### REQUEST ID ###",
    "accessToken": "### ACCESS TOKEN ###"
  },
  "limit": 0,
  "offset": 0,
  "filterRoomIds": [
    "### ROOM ID ###"
  ]
}

Response

{
  ...
    "rooms": {
      "2bed6af5-51b9-4188-be98-25b6623b7a0f": {
        "displayName": "Conference room 2",
        ...
      },
      "b495c2b7-7f43-49c5-81b2-e44d429bb215": {
        "displayName": "Conference room 3",
        ...
      },
      "c134df6f-990a-4f99-8020-8290295e840f": {
        "displayName": "Conference room 1",
        ...
      }
    }
}

Notes

  • limit, number of results, default:100 max:1000
  • offset, for paging, default:0
  • filterRoomIds, list of room IDs if you want to filter your query
  • Note that rooms are not ordered in any way

Last updated on July 3rd, 2025, 11:55 am