Просмотреть список
Возвращает список сотрудников с постраничной навигацией.
HTTP-запрос
GET https://api360.yandex.net/directory/v1/org/{orgId}/users\
?page={integer}\
&perPage={integer}
Path-параметры
* Обязательный параметр
Query-параметры
page | integer Номер страницы ответа. Значение по умолчанию — |
perPage | integer Количество сотрудников на одной странице ответа. Значение по умолчанию — |
page | integer Номер страницы ответа. Значение по умолчанию — |
perPage | integer Количество сотрудников на одной странице ответа. Значение по умолчанию — |
* Обязательный параметр
Ответы
Код 200
Запрос успешно выполнен.
{ "page": integer, "pages": integer, "perPage": integer, "total": integer, "users": [ { "about": string, "aliases": [ string ], "avatarId": string, "birthday": string, "contacts": [ { "alias": boolean, "label": string, "main": boolean, "synthetic": boolean, "type": string, "value": string } ], "createdAt": string, "departmentId": integer, "displayName": string, "email": string, "externalId": string, "gender": string, "groups": [ integer ], "id": string, "isAdmin": boolean, "isDismissed": boolean, "isEnabled": boolean, "isRobot": boolean, "language": string, "name": { "first": string, "last": string, "middle": string }, "nickname": string, "position": string, "timezone": string, "updatedAt": string } ] }
Скопировано
Представление
Поля
page | integer Номер страницы ответа. |
pages | integer Количество страниц ответа. |
perPage | integer Количество сотрудников на одной странице ответа. |
total | integer Общее количество сотрудников. |
users[] | array Список сотрудников. |
users[]. | string Описание сотрудника. |
users[]. | array Список алиасов сотрудника. |
users[]. | string Идентификатор портрета сотрудника. |
users[]. | string Дата рождения сотрудника. В формате |
users[]. | array Список контактов сотрудника. |
users[]. | boolean Если у сотрудника есть алиас, для него автоматически создается контакт типа |
users[]. | string Произвольная метка контакта. |
users[]. | boolean Признак основного контакта: |
users[]. | boolean Признак автоматически созданного контакта: |
users[]. | string Тип контакта. |
users[]. | string Значение контакта. |
users[]. | string Дата и время создания сотрудника. |
users[]. | integer Идентификатор подразделения, в котором состоит сотрудник. |
users[]. | string Публичное имя сотрудника – имя, которое сотрудник использует в своем профиле для представления себя, оно может совпадать с реальным именем, быть псевдонимом или никнеймом. |
users[]. | string Основной адрес электронной почты сотрудника. |
users[]. | string Произвольный внешний идентификатор сотрудника. |
users[]. | string Пол сотрудника. |
users[]. | array Идентификаторы групп, в которых состоит сотрудник. |
users[]. | string Идентификатор сотрудника. |
users[]. | boolean Признак администратора организации: |
users[]. | boolean Статус сотрудника: |
users[]. | boolean Статус аккаунта сотрудника: |
users[]. | boolean Признак служебных сотрудников-ботов: |
users[]. | string Язык сотрудника. |
users[]. | object ФИО сотрудника. |
users[]. | string Имя сотрудника. |
users[]. | string Фамилия сотрудника. |
users[]. | string Отчество сотрудника. |
users[]. | string Логин сотрудника. |
users[]. | string Должность сотрудника. |
users[]. | string Часовой пояс сотрудника. |
users[]. | string Дата и время изменения сотрудника. |
page | integer Номер страницы ответа. |
pages | integer Количество страниц ответа. |
perPage | integer Количество сотрудников на одной странице ответа. |
total | integer Общее количество сотрудников. |
users[] | array Список сотрудников. |
users[]. | string Описание сотрудника. |
users[]. | array Список алиасов сотрудника. |
users[]. | string Идентификатор портрета сотрудника. |
users[]. | string Дата рождения сотрудника. В формате |
users[]. | array Список контактов сотрудника. |
users[]. | boolean Если у сотрудника есть алиас, для него автоматически создается контакт типа |
users[]. | string Произвольная метка контакта. |
users[]. | boolean Признак основного контакта: |
users[]. | boolean Признак автоматически созданного контакта: |
users[]. | string Тип контакта. |
users[]. | string Значение контакта. |
users[]. | string Дата и время создания сотрудника. |
users[]. | integer Идентификатор подразделения, в котором состоит сотрудник. |
users[]. | string Публичное имя сотрудника – имя, которое сотрудник использует в своем профиле для представления себя, оно может совпадать с реальным именем, быть псевдонимом или никнеймом. |
users[]. | string Основной адрес электронной почты сотрудника. |
users[]. | string Произвольный внешний идентификатор сотрудника. |
users[]. | string Пол сотрудника. |
users[]. | array Идентификаторы групп, в которых состоит сотрудник. |
users[]. | string Идентификатор сотрудника. |
users[]. | boolean Признак администратора организации: |
users[]. | boolean Статус сотрудника: |
users[]. | boolean Статус аккаунта сотрудника: |
users[]. | boolean Признак служебных сотрудников-ботов: |
users[]. | string Язык сотрудника. |
users[]. | object ФИО сотрудника. |
users[]. | string Имя сотрудника. |
users[]. | string Фамилия сотрудника. |
users[]. | string Отчество сотрудника. |
users[]. | string Логин сотрудника. |
users[]. | string Должность сотрудника. |
users[]. | string Часовой пояс сотрудника. |
users[]. | string Дата и время изменения сотрудника. |
* Обязательный параметр
Код 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 |
* Обязательный параметр