Просмотреть список

Возвращает список сотрудников с постраничной навигацией.

Примечание

Требуется разрешение на чтение данных о сотрудниках.

Request

GET

https://api360.yandex.net/directory/v1/org/{orgId}/users

Path parameters

Name

Description

orgId*

Type: integer<int64>

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

Query parameters

Name

Description

page

Type: integer<int64>

Номер страницы ответа. Значение по умолчанию — 1.

perPage

Type: integer<int64>

Количество сотрудников на одной странице ответа. Значение по умолчанию — 10.

Responses

200 OK

Запрос успешно выполнен.

Body

application/json
{
    "users": [
        {
            "id": "string",
            "nickname": "string",
            "departmentId": 0,
            "email": "string",
            "name": {
                "first": "string",
                "last": "string",
                "middle": "string"
            },
            "gender": "string",
            "position": "string",
            "avatarId": "string",
            "about": "string",
            "birthday": "string",
            "contacts": [
                {
                    "type": "string",
                    "value": "string",
                    "main": false,
                    "alias": false,
                    "synthetic": false,
                    "label": "string"
                }
            ],
            "aliases": [
                "string"
            ],
            "groups": [
                0
            ],
            "externalId": "string",
            "isAdmin": false,
            "isRobot": false,
            "isDismissed": false,
            "isEnabled": false,
            "timezone": "string",
            "language": "string",
            "createdAt": "2022-12-29T18:02:01Z",
            "updatedAt": "2022-12-29T18:02:01Z"
        }
    ],
    "page": 0,
    "pages": 0,
    "perPage": 0,
    "total": 0
}

Name

Description

page

Type: integer<int64>

Номер страницы ответа.

pages

Type: integer<int64>

Количество страниц ответа.

perPage

Type: integer<int64>

Количество сотрудников на одной странице ответа.

total

Type: integer<int64>

Общее количество сотрудников.

users

Type: v1User[]

Список сотрудников.
Сотрудник.

v1User

Сотрудник.

Name

Description

about

Type: string

Описание сотрудника.

aliases

Type: string[]

Список алиасов сотрудника.

avatarId

Type: string

Идентификатор портрета сотрудника.

birthday

Type: string

Дата рождения сотрудника. В формате YYYY-MM-DD или пустая строка.

contacts

Type: v1UserContact[]

Список контактов сотрудника.
Контакты сотрудника.

createdAt

Type: string<date-time>

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

departmentId

Type: integer<int64>

Идентификатор подразделения, в котором состоит сотрудник.

email

Type: string

Основной адрес электронной почты сотрудника.

externalId

Type: string

Произвольный внешний идентификатор сотрудника.

gender

Type: string

Пол сотрудника.

groups

Type: integer<int64>[]

Идентификаторы групп, в которых состоит сотрудник.

id

Type: string<uint64>

Идентификатор сотрудника.

isAdmin

Type: boolean

Признак администратора организации: true — администратор; false — рядовой пользователь.

isDismissed

Type: boolean

Статус сотрудника: true — уволенный; false — действующий.

isEnabled

Type: boolean

Статус аккаунта сотрудника: true — активен; false — заблокирован.

isRobot

Type: boolean

Признак служебных сотрудников-ботов: true — бот; false — человек.

language

Type: string

Язык сотрудника.

name

Type: v1UserName

ФИО сотрудника.

nickname

Type: string

Логин сотрудника.

position

Type: string

Должность сотрудника.

timezone

Type: string

Часовой пояс сотрудника.

updatedAt

Type: string<date-time>

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

v1UserContact

Контакты сотрудника.

Name

Description

alias

Type: boolean

Если у сотрудника есть алиас, для него автоматически создается контакт типа email: true — контакт создан на основе алиаса; false — контакт создан вручную.

label

Type: string

Произвольная метка контакта.

main

Type: boolean

Признак основного контакта: true — основной; false — альтернативный.

synthetic

Type: boolean

Признак автоматически созданного контакта: true — контакт создан автоматически; false — контакт создан вручную.

type

Type: string

Тип контакта.

value

Type: string

Значение контакта.

v1UserName

ФИО сотрудника.

Name

Description

first

Type: string

Имя сотрудника.

last

Type: string

Фамилия сотрудника.

middle

Type: string

Отчество сотрудника.

401 Unauthorized

Пользователь не авторизован.

Body

application/json
{
    "code": 0,
    "message": "string",
    "details": [
        null
    ]
}

Name

Description

code

Type: integer<int32>

Код ошибки.

details

Type: any[]

Дополнительные сведения об ошибке.

message

Type: string

Описание ошибки.

403 Forbidden

У пользователя или приложения нет прав на доступ к ресурсу, запрос отклонен.

Body

application/json
{
    "code": 0,
    "message": "string",
    "details": [
        null
    ]
}

Name

Description

code

Type: integer<int32>

Код ошибки.

details

Type: any[]

Дополнительные сведения об ошибке.

message

Type: string

Описание ошибки.

404 Not Found

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

Body

application/json
{
    "code": 0,
    "message": "string",
    "details": [
        null
    ]
}

Name

Description

code

Type: integer<int32>

Код ошибки.

details

Type: any[]

Дополнительные сведения об ошибке.

message

Type: string

Описание ошибки.

500 Internal Server Error

Внутренняя ошибка сервиса. Попробуйте повторно отправить запрос через некоторое время.

Body

application/json
{
    "code": 0,
    "message": "string",
    "details": [
        null
    ]
}

Name

Description

code

Type: integer<int32>

Код ошибки.

details

Type: any[]

Дополнительные сведения об ошибке.

message

Type: string

Описание ошибки.
Предыдущая
Обзор
Следующая
Добавить