---
title: "List conference rooms"
method: GET
path: "/conference_rooms"
tags: ["Conference"]
---

# List conference rooms

`GET /conference_rooms`

Retrieve a collection of conference rooms

## Query parameters

- `filter` string
- `search` string
- `orderby` string
- `skip` integer
- `top` integer

## Response `200`

OK

- object
  - `count` integer — Total number of resource.
  - `items` object[]
    - `id` string — The unique ID of the resource.
    - `extension_number` string — The extension number.
    - `mode` 'AUDIO' | 'VIDEO' — The conference room mode. Can be either: - `AUDIO`: audio conference room. - `VIDEO`: video conference room.
    - `control` 'FREE' | 'MASTER' — The conference control type. Can be either: - `FREE`: the free mode. - `MASTER`: the master mode.
    - `height` integer — The height for video conference room. Only valid in `VIDEO` mode.
    - `width` integer — The width for video conference room. Only valid in `VIDEO` mode.
    - `bitrate` integer — The transmission rate for video conference room. Only valid in `VIDEO` mode.
    - `framerate` integer — The framerate for video conference room. Only valid in `VIDEO` mode.
    - `layout` 'LAYOUT0' | 'LAYOUT1' | 'LAYOUT2' | 'LAYOUT3' | 'LAYOUT4' | 'LAYOUT6' | 'LAYOUT9' — The number of grids allowed for video conference room. Only valid in `VIDEO` mode. Can be either: - LAYOUT0: - LAYOUT1: - LAYOUT2: - LAYOUT3: - LAYOUT4: - LAYOUT6: - LAYOUT9:
    - `subject` string — The subject of conference room.
    - `language` string — BCP 47 Language Tags (The Internet Best Current Practices (BCP) for language tags). A language tag is composed of a sequence of one or more subtags such as language, region, variant and script subtags. When a language tag is comprised of more than one subtag, the subtag values are separated by the "-" character. You will most commonly find language tags written with 2 subtags - language and region. For example: en-US.
    - `capacity` integer — The maximum number of participants allowed in the room.
    - `admin_pin` string — The PIN for admin of the conference room. Only numeric sequences are allowed.
    - `room_pin` string — The PIN for the conference room. Only numeric sequences are allowed.
    - `enable_recording` boolean — Whether to enable recording when created.
    - `enable_prompt` boolean — Whether to enable voice menu.
    - `timezone` string — The IANA Time Zone names, such as "Asia/Shanghai".
    - `created_at` string, date_time — The RFC 3339 format is defined by The date_time notation as defined by [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), for example, 2017-07-21T17:32:28Z
    - `scheduled_start_at` string, date_time — The RFC 3339 format is defined by The date_time notation as defined by [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), for example, 2017-07-21T17:32:28Z
    - `scheduled_end_at` string, date_time — The RFC 3339 format is defined by The date_time notation as defined by [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), for example, 2017-07-21T17:32:28Z
    - `numbers` string — Dial from landline/mobile phone to this number.
    - `internal_invitees` string[]
    - `external_invitees` string — The invitees to send invitation emails to.
    - `custom_options` string — Some custom configuration options serialized as json string

## Other responses

- `4XX` — Error

---

[API](https://skmtc.net/portsip/apis/portsip-pbx-rest-api.md) · [All operations](https://skmtc.net/portsip/apis/portsip-pbx-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/portsip/portsip-pbx-rest-api/revisions/577415d4a3d5/schema)