> For a complete index of all SignalWire documentation pages, fetch https://signalwire.com/docs/llms.txt

# list

> List conference room resources.

List conference room resources in the project.

### Schema

```yaml
openapi: 3.1.0
info:
  title: API
  version: 1.0.0
paths:
  /api/fabric/resources/conference_rooms:
    get:
      operationId: list_conference_rooms
      summary: List conference rooms
      description: >-
        Returns a list of conference rooms.


        #### Permissions


        The API token used to authenticate must have the following scope(s)
        enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or
        _Video_.


        [Learn more about API scopes](/docs/platform/your-signalwire-api-space).
      tags:
        - subpackage_conferenceRooms
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConferenceRoomListResponse'
        '401':
          description: Access is unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode401'
        '404':
          description: The server cannot find the requested resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode404'
        '500':
          description: An internal server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode500'
servers:
  - url: https://%7BYour_Space_Name%7D.signalwire.com
    description: SignalWire API
components:
  schemas:
    ConferenceRoomAddressPaginationResponse:
      type: object
      properties:
        self:
          type: string
          format: uri
          description: Link of the current page
        first:
          type: string
          format: uri
          description: Link to the first page
        next:
          type: string
          format: uri
          description: Link to the next page
        prev:
          type: string
          format: uri
          description: Link to the previous page
      required:
        - self
        - first
      title: ConferenceRoomAddressPaginationResponse
    uuid:
      type: string
      format: uuid
      description: Universal Unique Identifier.
      title: uuid
    ConferenceRoomResponseType:
      type: string
      enum:
        - video_room
      description: Type of the Fabric Resource
      title: ConferenceRoomResponseType
    ConferenceRoomQuality:
      type: string
      enum:
        - 1080p
        - 720p
      default: 720p
      description: The viudeo quality of the Conference Room.
      title: ConferenceRoomQuality
    ConferenceRoomFps:
      type: string
      enum:
        - '30'
        - '20'
      description: >-
        The frames-per-second (fps) of the participants videos in the
        conference.
      title: ConferenceRoomFps
    Layout:
      type: string
      enum:
        - grid-responsive
        - grid-responsive-mobile
        - highlight-1-responsive
        - 1x1
        - 2x1
        - 2x2
        - 5up
        - 3x3
        - 4x4
        - 5x5
        - 6x6
        - 8x8
        - 10x10
      title: Layout
    ConferenceRoomMeta:
      type: object
      properties: {}
      description: Metadata of the conference.
      title: ConferenceRoomMeta
    ConferenceRoom:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/uuid'
          description: The unique id of the Conference Room
        name:
          type: string
          description: The name of the Conference Room
        description:
          type: string
          description: The descrption of the Conference Room
        display_name:
          type: string
          description: Display name of the Conference Room
        max_members:
          type: integer
          description: Maximum number of members allowed in the conference room
        quality:
          $ref: '#/components/schemas/ConferenceRoomQuality'
          description: The viudeo quality of the Conference Room.
        fps:
          $ref: '#/components/schemas/ConferenceRoomFps'
          description: >-
            The frames-per-second (fps) of the participants videos in the
            conference.
        join_from:
          type:
            - string
            - 'null'
          format: date-time
          description: >-
            The time users are allowed to start joining the conference. Joining
            before this time will result in failure to join the conference.
        join_until:
          type:
            - string
            - 'null'
          format: date-time
          description: >-
            The time users are allowed to until the conference is locked.
            Attempting to join the conference after the set time will result in
            failure to join the conference.
        remove_at:
          type:
            - string
            - 'null'
          format: date-time
          description: The time to remove all participants from the conference.
        remove_after_seconds_elapsed:
          type:
            - integer
            - 'null'
          description: >-
            The amount of time in seconds to remove a particpant from a
            conference after they join.
        layout:
          $ref: '#/components/schemas/Layout'
          description: The video layout of the conference.
        record_on_start:
          type: boolean
          description: Starts recording when the conference starts.
        tone_on_entry_and_exit:
          type: boolean
          description: Plays a tone when a participant joins or leaves the conference.
        room_join_video_off:
          type: boolean
          description: >-
            Turns the conference video off when the participant joins the room
            if `true`.
        user_join_video_off:
          type: boolean
          description: >-
            Turns the participants video off when the participant joins the room
            if `true`.
        enable_room_previews:
          type: boolean
          description: Enables live video room previews for the conference.
        sync_audio_video:
          type:
            - boolean
            - 'null'
          description: Syncs the participants audio and video.
        meta:
          $ref: '#/components/schemas/ConferenceRoomMeta'
          description: Metadata of the conference.
        prioritize_handraise:
          type: boolean
          description: >-
            Indicator if the Conference Room will prioritize showing
            participants utilizing the hand raised feature.
      required:
        - id
        - name
        - description
        - display_name
        - max_members
        - quality
        - fps
        - join_from
        - join_until
        - remove_at
        - remove_after_seconds_elapsed
        - layout
        - record_on_start
        - tone_on_entry_and_exit
        - room_join_video_off
        - user_join_video_off
        - enable_room_previews
        - sync_audio_video
        - meta
        - prioritize_handraise
      title: ConferenceRoom
    ConferenceRoomResponse:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/uuid'
          description: Unique ID of the Conference Room.
        project_id:
          $ref: '#/components/schemas/uuid'
          description: Unique ID of the Project.
        display_name:
          type: string
          description: Display name of the Conference Room Fabric Resource
        type:
          $ref: '#/components/schemas/ConferenceRoomResponseType'
          description: Type of the Fabric Resource
        created_at:
          type: string
          format: date-time
          description: Date and time when the resource was created.
        updated_at:
          type: string
          format: date-time
          description: Date and time when the resource was updated.
        conference_room:
          $ref: '#/components/schemas/ConferenceRoom'
          description: Conference Room data.
      required:
        - id
        - project_id
        - display_name
        - type
        - created_at
        - updated_at
        - conference_room
      title: ConferenceRoomResponse
    ConferenceRoomListResponse:
      type: object
      properties:
        links:
          $ref: '#/components/schemas/ConferenceRoomAddressPaginationResponse'
          description: Object containing pagination links
        data:
          type: array
          items:
            $ref: '#/components/schemas/ConferenceRoomResponse'
          description: An array of objects containing the Conference Room data
      required:
        - links
        - data
      title: ConferenceRoomListResponse
    TypesStatusCodesStatusCode401Error:
      type: string
      enum:
        - Unauthorized
      title: TypesStatusCodesStatusCode401Error
    Types.StatusCodes.StatusCode401:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/TypesStatusCodesStatusCode401Error'
      required:
        - error
      description: Access is unauthorized.
      title: Types.StatusCodes.StatusCode401
    TypesStatusCodesStatusCode404Error:
      type: string
      enum:
        - Not Found
      title: TypesStatusCodesStatusCode404Error
    Types.StatusCodes.StatusCode404:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/TypesStatusCodesStatusCode404Error'
      required:
        - error
      description: The server cannot find the requested resource.
      title: Types.StatusCodes.StatusCode404
    TypesStatusCodesStatusCode500Error:
      type: string
      enum:
        - Internal Server Error
      title: TypesStatusCodesStatusCode500Error
    Types.StatusCodes.StatusCode500:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/TypesStatusCodesStatusCode500Error'
      required:
        - error
      description: An internal server error occurred.
      title: Types.StatusCodes.StatusCode500

```

## **Response Example**

### Response (200)

```json
{
  "links": {
    "self": "https://example.signalwire.com/api/fabric/resources/conference_room/016e5773-c197-4446-bcc2-9c48f14e2d0a/addresses?page_number=0&page_size=50&type=conference_room",
    "first": "https://example.signalwire.com/api/fabric/resources/conference_room/016e5773-c197-4446-bcc2-9c48f14e2d0a/addresses?page_number=0&page_size=50&type=conference_room",
    "next": "https://example.signalwire.com/api/fabric/resources/conference_room/016e5773-c197-4446-bcc2-9c48f14e2d0a/addresses?page_number=1&page_size=50&page_token=PA6581c1fa-d985-4c8f-b53e-2fee11b579ad&type=conference_room",
    "prev": "https://example.signalwire.com/api/fabric/resources/conference_room/016e5773-c197-4446-bcc2-9c48f14e2d0a/addresses?page_number=0&page_size=50&page_token=PA6581c1fa-d985-4c8f-b53e-2fee11b579ad&type=conference_room"
  },
  "data": [
    {
      "id": "993ed018-9e79-4e50-b97b-984bd5534095",
      "project_id": "1313fe58-5e14-4c11-bbe7-6fdfa11fe780",
      "display_name": "Reception",
      "type": "video_room",
      "created_at": "2024-05-06T12:20:00Z",
      "updated_at": "2024-05-06T12:20:00Z",
      "conference_room": {
        "id": "1bd571e4-5ea4-4a70-a3c8-2bab5d20e754",
        "name": "coffee_cafe",
        "description": "This room is for coffee, no shop talk",
        "display_name": "Reception",
        "max_members": 30,
        "quality": "1080p",
        "fps": 30,
        "join_from": "2024-05-06T12:20:00Z",
        "join_until": "2024-05-06T12:20:00Z",
        "remove_at": "2024-05-06T12:20:00Z",
        "remove_after_seconds_elapsed": 1,
        "layout": "grid-responsive",
        "record_on_start": true,
        "tone_on_entry_and_exit": true,
        "room_join_video_off": true,
        "user_join_video_off": true,
        "enable_room_previews": true,
        "sync_audio_video": true,
        "meta": {
          "foo": "bar"
        },
        "prioritize_handraise": false
      }
    }
  ]
}
```

## **Example**

```typescript {9}
import { RestClient } from "@signalwire/sdk";

const client = new RestClient({
  project: "your-project-id",
  token: "your-api-token",
  host: "your-space.signalwire.com"
});

const response = await client.fabric.conferenceRooms.list();
for (const room of response.data ?? []) {
  console.log(`${room.display_name}: ${room.id}`);
}
```