Получить список офисов организации
Возвращает список офисов организации. Метод также можно использовать для поиска конкретного офиса по его идентификатору.
Примечание
Чтобы выполнить запрос, приложению требуется одно из разрешений:
directory:read_offices— просмотр данных офисов;directory:write_offices— просмотр и изменение данных офисов.
Запрос
GET https://cloud-api.yandex.net/v1/directory/organizations/{org_id}/offices
Path-параметры
|
Имя параметра |
Тип |
Описание |
|
org_id * |
integer |
Идентификатор организации. |
Query-параметры
|
Имя параметра |
Тип |
Описание |
|
ids |
string |
Идентификаторы офисов, которые должны быть включены в список. Чтобы указать несколько офисов, задайте их идентификаторы через запятую без пробела, например |
|
limit |
integer |
Максимальное количество записей в ответе. |
|
offset |
integer |
Смещение, с которого начинается выборка данных. Поддерживаются только значения |
Заголовки
Authorization: OAuth <токен>
Пример
Пример запроса
curl --request GET \
--url 'https://cloud-api.yandex.net/v1/directory/organizations/167730/offices' \
--header 'authorization: OAuth <токен>'
Ответ
Успешный ответ
Результатом корректного запроса является ответ с кодом 200 и телом в формате JSON, где содержится объект со списком офисов.
200 OK — запрос выполнен успешно.
|
Имя параметра |
Тип |
Описание |
|
limit |
integer |
Максимальное количество записей в ответе. |
|
offset |
integer |
Смещение, с которого начинается выборка данных. |
|
total |
integer |
Общее количество записей, подходящих по параметрам запроса. |
|
items |
v1Office[] |
Список офисов организации. |
v1Office
|
Поле |
Тип |
Описание |
|
id |
string |
Идентификатор офиса. |
|
name |
string |
Название офиса. |
|
address |
string |
Адрес офиса. |
|
city |
string |
Город, в котором расположен офис. |
|
created_at |
string<date-time> |
Дата и время создания офиса. |
|
updated_at |
string<date-time> |
Дата и время последнего изменения данных офиса. |
Пример
Пример ответа
{
"items": [
{
"id": "c3e9a742-16bd-4f58-a201-8d4f7b1e2c93",
"name": "Головной офис",
"address": "115088, ул. Янтарная, 12, стр. 3",
"city": "Соснополь",
"created_at": "2025-01-14T08:22:19.114562+03:00",
"updated_at": "2025-01-14T08:22:19.098431+03:00"
},
{
"id": "9b5d2e18-4a76-4c03-bf91-2e8a1f6d5c40",
"name": "Филиал на Северной",
"address": "443045, ул. Березовая роща, 78, оф. 305",
"city": "Верхнегорск",
"created_at": "2025-02-28T13:07:55.673210+03:00",
"updated_at": "2025-06-11T10:41:33.220985+03:00"
},
{
"id": "e47f0a91-8c23-4d65-a190-5f3b7c2e9d18",
"name": "Складской комплекс",
"address": "660135, Промышленный проезд, 9",
"city": "Озерск-Дальний",
"created_at": "2025-05-19T15:48:07.991204+03:00",
"updated_at": "2025-05-19T15:48:07.955118+03:00"
}
],
"total": 3,
"limit": 20,
"offset": 0
}
Неуспешный ответ
Ошибки могут быть со следующими HTTP-статусами:
400 Bad Request— параметры запроса не заданы или заданы неверно;401 Unauthorized— пользователь не авторизован;403 Forbidden— у пользователя или приложения нет прав на доступ к списку офисов;404 Not Found— запрашиваемая организация не найдена;422 Unprocessable Entity— переданы некорректные данные (например, неверное значение поля);500 Internal Server Error— ошибка произошла на стороне сервера (в этом случае попробуйте повторно отправить запрос через некоторое время).