Получить список переговорок организации

Возвращает список переговорок организации. Метод также можно использовать для поиска конкретной переговорки по ее идентификатору или для фильтрации переговорок по офисам.

Примечание

Чтобы выполнить запрос, приложению требуется одно из разрешений:

directory:read_rooms — просмотр данных переговорок;
directory:write_rooms — просмотр и изменение данных переговорок.

Запрос

GET https://cloud-api.yandex.net/v1/directory/organizations/{org_id}/rooms

Path-параметры

Имя параметра	Тип	Описание
org_id *	integer	Идентификатор организации.

Query-параметры

Имя параметра	Тип	Описание
ids	string	Идентификаторы переговорок, которые должны быть включены в список. Чтобы указать несколько переговорок, задайте их идентификаторы через запятую без пробела, например `ids=1,2,3`.
office_ids	string	Идентификаторы офисов, по которым будут отфильтрованы переговорки. Чтобы указать несколько офисов, задайте их идентификаторы через запятую без пробела, например `office_ids=1,2,3`.
limit	integer	Максимальное количество записей в ответе.
offset	integer	Смещение, с которого начинается выборка данных. Поддерживаются только значения `offset`, кратные значению `limit`.

Заголовки

Authorization: OAuth <токен>

Пример

Пример запроса

curl --request GET \
--url 'https://cloud-api.yandex.net/v1/directory/organizations/167730/rooms' \
--header 'authorization: OAuth <токен>'

Ответ

Успешный ответ

Результатом корректного запроса является ответ с кодом 200 и телом в формате JSON, где содержится объект со списком переговорок.

200 OK — запрос выполнен успешно.

Имя параметра	Тип	Описание
limit	integer	Максимальное количество записей в ответе.
offset	integer	Смещение, с которого начинается выборка данных.
total	integer	Общее количество записей, подходящих по параметрам запроса.
items	v1Room[]	Список переговорок организации.

v1Room

Поле	Тип	Описание
id	string	Идентификатор переговорки.
uid	integer<int64>	Числовой идентификатор переговорки.
name	string	Название переговорки.
email	string	Адрес электронной почты переговорки.
office_id	string	Идентификатор офиса, в котором расположена переговорка.
capacity	integer	Вместимость переговорки (количество человек).
floor	integer	Этаж, на котором расположена переговорка.
can_book	boolean	Признак возможности бронирования переговорки: `true` — можно забронировать; `false` — бронирование недоступно.
description	string	Описание переговорки.
created_at	string<date-time>	Дата и время создания переговорки.
updated_at	string<date-time>	Дата и время последнего изменения данных переговорки.

Пример

Пример ответа

{
  "items": [
    {
      "id": "a1b2c3d4-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
      "uid": 1130000012345678,
      "name": "Байкал",
      "email": "baikal@sdfdafsd.auto.connect-tk.tk",
      "office_id": "c3e9a742-16bd-4f58-a201-8d4f7b1e2c93",
      "capacity": 12,
      "floor": 3,
      "can_book": true,
      "description": "Большая переговорка с видеосвязью",
      "created_at": "2025-01-14T08:22:19.114562+03:00",
      "updated_at": "2025-01-14T08:22:19.098431+03:00"
    },
    {
      "id": "f6e5d4c3-2b1a-4f8e-9d7c-6b5a4c3d2e1f",
      "uid": 1130000087654321,
      "name": "Эльбрус",
      "email": "elbrus@sdfdafsd.auto.connect-tk.tk",
      "office_id": "c3e9a742-16bd-4f58-a201-8d4f7b1e2c93",
      "capacity": 4,
      "floor": 2,
      "can_book": false,
      "description": "",
      "created_at": "2025-02-28T13:07:55.673210+03:00",
      "updated_at": "2025-06-11T10:41:33.220985+03:00"
    }
  ],
  "total": 2,
  "limit": 20,
  "offset": 0
}

Неуспешный ответ

Ошибки могут быть со следующими HTTP-статусами:

400 Bad Request — параметры запроса не заданы или заданы неверно;
401 Unauthorized — пользователь не авторизован;
403 Forbidden — у пользователя или приложения нет прав на доступ к списку переговорок;
404 Not Found — запрашиваемая организация не найдена;
422 Unprocessable Entity — переданы некорректные данные (например, неверное значение поля);
500 Internal Server Error — ошибка произошла на стороне сервера (в этом случае попробуйте повторно отправить запрос через некоторое время).

Была ли статья полезна?

Удалить офис

Создать переговорку