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

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

Отправить запрос может администратор организации или сотрудник с ролью Менеджер пользователей.

Request

GET

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

Path parameters

Name

Description

org_id

Type: integer

Идентификатор организации.

Query parameters

Name

Description

ids

Type: string

Идентификаторы переговорок, которые должны быть включены в список.

Чтобы указать несколько переговорок, задайте их идентификаторы через запятую без пробела, например ids=1,2,3.

Example: abcdef12-3456-4789-abcd-ef1234567890,12345678-90ab-4cde-8f01-234567890abc

limit

Type: integer

Максимальное количество записей в ответе.

office_ids

Type: string

Идентификаторы офисов, по которым будут отфильтрованы переговорки.

Чтобы указать несколько офисов, задайте их идентификаторы через запятую без пробела, например office_ids=1,2,3.

Example: 12345678-90ab-4cde-8f01-234567890abc,abcdef12-3456-4789-abcd-ef1234567890

offset

Type: integer

Смещение, с которого начинается выборка данных. Поддерживаются только значения offset, кратные значению limit.

Responses

200 OK

Список переговорок организации получен.

Body

application/json
{
  "items": [
    {
      "id": "abcdef12-3456-4789-abcd-ef1234567890",
      "uid": 1230000000000001,
      "name": "Переговорка 1",
      "email": "meeting-room@example.com",
      "default_email": "meeting-room@example.com",
      "office_id": "12345678-90ab-4cde-8f01-234567890abc",
      "capacity": 8,
      "floor": 3,
      "can_book": true,
      "description": "Переговорка рядом с центральным входом.",
      "name_en": "Meeting room",
      "description_en": "Room on the second floor",
      "has_video_conference": false,
      "video_conference_number": "001234;ext=56",
      "has_whiteboard": false,
      "has_table": true,
      "map_link": {
        "href": "https://example.org/offices/main",
        "method": "GET",
        "templated": false
      },
      "has_projector": false,
      "group_name": "Building A",
      "chairs_count": 0,
      "extra_seats_count": 0,
      "created_at": "2026-05-01T10:00:00+00:00",
      "updated_at": "2026-05-02T10:00:00+00:00"
    }
  ],
  "total": 2,
  "limit": 20,
  "offset": 0
}

Name

Description

items

Type: OrganizationsRoomsItems

Список переговорок организации.

Example
[
  {
    "id": "abcdef12-3456-4789-abcd-ef1234567890",
    "uid": 1230000000000001,
    "name": "Переговорка 1",
    "email": "meeting-room@example.com",
    "default_email": "meeting-room@example.com",
    "office_id": "12345678-90ab-4cde-8f01-234567890abc",
    "capacity": 8,
    "floor": 3,
    "can_book": true,
    "description": "Переговорка рядом с центральным входом.",
    "name_en": "Meeting room",
    "description_en": "Room on the second floor",
    "has_video_conference": false,
    "video_conference_number": "001234;ext=56",
    "has_whiteboard": false,
    "has_table": true,
    "map_link": {
      "href": "https://example.org/offices/main",
      "method": "GET",
      "templated": false
    },
    "has_projector": false,
    "group_name": "Building A",
    "chairs_count": 0,
    "extra_seats_count": 0,
    "created_at": "2026-05-01T10:00:00+00:00",
    "updated_at": "2026-05-02T10:00:00+00:00"
  }
]

limit

Type: integer

Максимальное количество записей в ответе.

offset

Type: integer

Смещение, с которого начинается выборка данных.

total

Type: integer

Общее количество записей, подходящих по параметрам запроса.

Ссылка на карту или инструкцию, как найти офис или переговорную комнату.

Name

Description

href

Type: string

URL со схемой http или https.

Example: https://example.org/offices/main

method

Type: string

HTTP-метод перехода по ссылке.

Const: GET

Example: GET

templated

Type: boolean

Признак шаблонизированной ссылки. Для ссылки на карту всегда false.
Example
{
  "href": "https://example.org/offices/main",
  "method": "GET",
  "templated": false
}

RoomsRoom

Данные переговорной комнаты.

Name

Description

can_book

Type: boolean

Признак возможности бронирования переговорки:

  • true — можно забронировать;
  • false — бронирование недоступно.

capacity

Type: integer

Вместимость переговорки (количество человек).

chairs_count

Type: integer

Количество стульев.

Min value: 0

Max value: 2147483647

created_at

Type: string

Дата и время создания переговорки.

Example: 2026-05-01T10:00:00+00:00

default_email

Type: string

Адрес, используемый по умолчанию.

Example: meeting-room@example.com

description

Type: string

Описание переговорной комнаты на русском.

Example: Переговорка рядом с центральным входом.

description_en

Type: string

Описание переговорной комнаты на английском.

Example: Room on the second floor

email

Type: string

Адрес электронной почты переговорки.

Example: meeting-room@example.com

extra_seats_count

Type: integer

Количество дополнительных мест или складных стульев.

Min value: 0

Max value: 2147483647

floor

Type: integer

Этаж, на котором расположена переговорка.

group_name

Type: string

Произвольное название группы переговорных комнат, например корпуса офиса.

Example: Building A

has_projector

Type: boolean

Наличие проектора.

has_table

Type: boolean

Наличие стола.

has_video_conference

Type: boolean

Наличие оборудования для видеоконференций.

has_whiteboard

Type: boolean

Наличие маркерной доски.

id

Type: string

Идентификатор переговорки.

Example: abcdef12-3456-4789-abcd-ef1234567890

map_link

Type: MapLink

Ссылка на карту или инструкцию, как найти офис или переговорную комнату.

Example
{
  "href": "https://example.org/offices/main",
  "method": "GET",
  "templated": false
}

name

Type: string

Название переговорной комнаты на русском.

Example: Переговорка 1

name_en

Type: string

Название переговорной комнаты на английском.

Example: Meeting room

office_id

Type: string

Идентификатор офиса, в котором расположена переговорка.

Example: 12345678-90ab-4cde-8f01-234567890abc

uid

Type: integer

Числовой идентификатор переговорки.

updated_at

Type: string

Дата и время последнего изменения данных переговорки.

Example: 2026-05-02T10:00:00+00:00

video_conference_number

Type: string

Номер видеоконференции, включая добавочный номер.

Example: 001234;ext=56
Example
{
  "id": "abcdef12-3456-4789-abcd-ef1234567890",
  "uid": 1230000000000001,
  "name": "Переговорка 1",
  "email": "meeting-room@example.com",
  "default_email": "meeting-room@example.com",
  "office_id": "12345678-90ab-4cde-8f01-234567890abc",
  "capacity": 8,
  "floor": 3,
  "can_book": true,
  "description": "Переговорка рядом с центральным входом.",
  "name_en": "Meeting room",
  "description_en": "Room on the second floor",
  "has_video_conference": false,
  "video_conference_number": "001234;ext=56",
  "has_whiteboard": false,
  "has_table": true,
  "map_link": {
    "href": "https://example.org/offices/main",
    "method": "GET",
    "templated": false
  },
  "has_projector": false,
  "group_name": "Building A",
  "chairs_count": 0,
  "extra_seats_count": 0,
  "created_at": "2026-05-01T10:00:00+00:00",
  "updated_at": "2026-05-02T10:00:00+00:00"
}

OrganizationsRoomsItems

Список переговорок организации.

Type: RoomsRoom[]

Example
[
  {
    "id": "abcdef12-3456-4789-abcd-ef1234567890",
    "uid": 1230000000000001,
    "name": "Переговорка 1",
    "email": "meeting-room@example.com",
    "default_email": "meeting-room@example.com",
    "office_id": "12345678-90ab-4cde-8f01-234567890abc",
    "capacity": 8,
    "floor": 3,
    "can_book": true,
    "description": "Переговорка рядом с центральным входом.",
    "name_en": "Meeting room",
    "description_en": "Room on the second floor",
    "has_video_conference": false,
    "video_conference_number": "001234;ext=56",
    "has_whiteboard": false,
    "has_table": true,
    "map_link": {
      "href": "https://example.org/offices/main",
      "method": "GET",
      "templated": false
    },
    "has_projector": false,
    "group_name": "Building A",
    "chairs_count": 0,
    "extra_seats_count": 0,
    "created_at": "2026-05-01T10:00:00+00:00",
    "updated_at": "2026-05-02T10:00:00+00:00"
  }
]

400 Bad Request

Некорректный запрос.

Body

application/json
{
  "error": "bad_request",
  "description": "Bad request",
  "message": "Bad request",
  "details": {}
}

Name

Description

description

Type: string

Техническое описание ошибки.

Example: Bad request

error

Type: string

Код ошибки

Example: bad_request

message

Type: string

Сообщение об ошибке.

Example: Bad request

details
Type: object

Дополнительные детали ошибки

Example
{}

403 Forbidden

Возможные ошибки:

  • Authorization error
  • SSO user default email change is prohibited
  • SSO user personal info change is prohibited

Body

application/json
{
  "error": "forbidden",
  "description": "Forbidden",
  "message": "Forbidden",
  "details": {}
}

Name

Description

description

Type: string

Техническое описание ошибки.

Example: Forbidden

error

Type: string

Код ошибки

Example: forbidden

message

Type: string

Сообщение об ошибке.

Example: Forbidden

details
Type: object

Дополнительные детали ошибки

Example
{}

404 Not Found

Запрашиваемый ресурс не найден.

Body

application/json
{
  "error": "not_found",
  "description": "Not found",
  "message": "Not found",
  "details": {}
}

Name

Description

description

Type: string

Техническое описание ошибки.

Example: Not found

error

Type: string

Код ошибки

Example: not_found

message

Type: string

Сообщение об ошибке.

Example: Not found

details
Type: object

Дополнительные детали ошибки

Example
{}

422 Unprocessable Entity

Возможные ошибки:

  • Invalid data
  • Missing required field
  • Invalid field value
  • Invalid request body
  • Default email must be one of the user's existing emails
  • Invalid default email
  • Default email cannot be empty
  • Invalid display name
  • Display name cannot be empty

Body

application/json
{
  "error": "invalid_data",
  "description": "Invalid data",
  "message": "Invalid data",
  "details": {}
}

Name

Description

description

Type: string

Техническое описание ошибки.

Example: Invalid data

error

Type: string

Код ошибки

Example: invalid_data

message

Type: string

Сообщение об ошибке.

Example: Invalid data

details
Type: object

Дополнительные детали ошибки

Example
{}
Предыдущая
Удалить офис
Следующая
Создать переговорку