Посмотреть список подразделений
Возвращает список подразделений с постраничной навигацией.
HTTP-запрос
GET https://api360.yandex.net/directory/v1/org/{orgId}/departments\
?page={integer}\
&perPage={integer}\
&parentId={integer}\
&orderBy={string}
Path-параметры
* Обязательный параметр
Query-параметры
page | integer Номер страницы ответа. Значение по умолчанию — |
perPage | integer Количество подразделений на одной странице ответа. Значение по умолчанию — |
parentId | integer Идентификатор родительского подразделения. Если не указан, то выводятся все подразделения организации. |
orderBy | string Вид сортировки.
Значение по умолчанию: |
page | integer Номер страницы ответа. Значение по умолчанию — |
perPage | integer Количество подразделений на одной странице ответа. Значение по умолчанию — |
parentId | integer Идентификатор родительского подразделения. Если не указан, то выводятся все подразделения организации. |
orderBy | string Вид сортировки.
Значение по умолчанию: |
* Обязательный параметр
Ответы
Код 200
Запрос успешно выполнен.
{ "departments": [ { "aliases": [ string ], "createdAt": string, "description": string, "email": string, "externalId": string, "headId": string, "id": integer, "label": string, "membersCount": integer, "name": string, "parentId": integer } ], "page": integer, "pages": integer, "perPage": integer, "total": integer }
Скопировано
Представление
Поля
departments[] | array Список подразделений. |
departments[]. | array Алиасы почтовых рассылок. |
departments[]. | string Дата и время создания подразделения. |
departments[]. | string Описание подразделения. |
departments[]. | string Адрес почтовой рассылки подразделения. |
departments[]. | string Произвольный внешний идентификатор подразделения. |
departments[]. | string Руководитель подразделения. |
departments[]. | integer Идентификатор подразделения. |
departments[]. | string Имя почтовой рассылки подразделения. Например, для адреса |
departments[]. | integer Количество сотрудников подразделения с учетом вложенных подразделений. |
departments[]. | string Название подразделения. |
departments[]. | integer Идентификатор родительского подразделения. |
page | integer Номер страницы ответа. |
pages | integer Количество страниц ответа. |
perPage | integer Количество подразделений на одной странице ответа. |
total | integer Общее количество подразделений. |
departments[] | array Список подразделений. |
departments[]. | array Алиасы почтовых рассылок. |
departments[]. | string Дата и время создания подразделения. |
departments[]. | string Описание подразделения. |
departments[]. | string Адрес почтовой рассылки подразделения. |
departments[]. | string Произвольный внешний идентификатор подразделения. |
departments[]. | string Руководитель подразделения. |
departments[]. | integer Идентификатор подразделения. |
departments[]. | string Имя почтовой рассылки подразделения. Например, для адреса |
departments[]. | integer Количество сотрудников подразделения с учетом вложенных подразделений. |
departments[]. | string Название подразделения. |
departments[]. | integer Идентификатор родительского подразделения. |
page | integer Номер страницы ответа. |
pages | integer Количество страниц ответа. |
perPage | integer Количество подразделений на одной странице ответа. |
total | integer Общее количество подразделений. |
* Обязательный параметр
Код 401
Пользователь не авторизован.
{ "code": integer, "details": [ { "@type": string } ], "message": string }
Скопировано
Представление
Поля
code | integer |
details[] | array |
details[]. | string |
message | string |
code | integer |
details[] | array |
details[]. | string |
message | string |
* Обязательный параметр
Код 403
У пользователя или приложения нет прав на доступ к ресурсу, запрос отклонен.
{ "code": integer, "details": [ { "@type": string } ], "message": string }
Скопировано
Представление
Поля
code | integer |
details[] | array |
details[]. | string |
message | string |
code | integer |
details[] | array |
details[]. | string |
message | string |
* Обязательный параметр
Код 404
Запрашиваемый ресурс не найден.
{ "code": integer, "details": [ { "@type": string } ], "message": string }
Скопировано
Представление
Поля
code | integer |
details[] | array |
details[]. | string |
message | string |
code | integer |
details[] | array |
details[]. | string |
message | string |
* Обязательный параметр
Код 500
Внутренняя ошибка сервиса. Попробуйте повторно отправить запрос через некоторое время.
{ "code": integer, "details": [ { "@type": string } ], "message": string }
Скопировано
Представление
Поля
code | integer |
details[] | array |
details[]. | string |
message | string |
code | integer |
details[] | array |
details[]. | string |
message | string |
* Обязательный параметр