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

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

Примечание

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

Request

GET

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

Path parameters

Name

Description

orgId

Type: integer

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

Query parameters

Name

Description

page

Type: integer

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

perPage

Type: integer

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

Responses

200 OK

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

Body

application/json

{
  "users": [
    {
      "id": "example",
      "nickname": "example",
      "departmentId": 0,
      "email": "example",
      "name": {
        "first": "example",
        "last": "example",
        "middle": "example"
      },
      "gender": "example",
      "position": "example",
      "avatarId": "example",
      "about": "example",
      "birthday": "example",
      "contacts": [
        {
          "type": "example",
          "value": "example",
          "main": true,
          "alias": true,
          "synthetic": true,
          "label": "example"
        }
      ],
      "aliases": [
        "example"
      ],
      "groups": [
        0
      ],
      "externalId": "example",
      "isAdmin": true,
      "isRobot": true,
      "isDismissed": true,
      "isEnabled": true,
      "isEnabledUpdatedAt": "2025-01-01T00:00:00Z",
      "timezone": "example",
      "language": "example",
      "createdAt": "2025-01-01T00:00:00Z",
      "updatedAt": "2025-01-01T00:00:00Z"
    }
  ],
  "page": 0,
  "pages": 0,
  "perPage": 0,
  "total": 0
}

Name	Description
page	Type: integer Номер страницы ответа.
pages	Type: integer Количество страниц ответа.
perPage	Type: integer Количество сотрудников на одной странице ответа.
total	Type: integer Общее количество сотрудников.
users	Type: v1User[] Список сотрудников. Example [ { "id": "example", "nickname": "example", "departmentId": 0, "email": "example", "name": { "first": "example", "last": "example", "middle": "example" }, "gender": "example", "position": "example", "avatarId": "example", "about": "example", "birthday": "example", "contacts": [ { "type": "example", "value": "example", "main": true, "alias": true, "synthetic": true, "label": "example" } ], "aliases": [ "example" ], "groups": [ 0 ], "externalId": "example", "isAdmin": true, "isRobot": true, "isDismissed": true, "isEnabled": true, "isEnabledUpdatedAt": "2025-01-01T00:00:00Z", "timezone": "example", "language": "example", "createdAt": "2025-01-01T00:00:00Z", "updatedAt": "2025-01-01T00:00:00Z" } ]

v1UserName

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

Name	Description
first	Type: string Имя сотрудника. Example: `example`
last	Type: string Фамилия сотрудника. Example: `example`
middle	Type: string Отчество сотрудника. Example: `example`

Example

{
  "first": "example",
  "last": "example",
  "middle": "example"
}

v1UserContact

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

Name	Description
alias	Type: boolean Если у сотрудника есть алиас, для него автоматически создается контакт типа `email`: `true` — контакт создан на основе алиаса; `false` — контакт создан вручную.
label	Type: string Произвольная метка контакта. Example: `example`
main	Type: boolean Признак основного контакта: `true` — основной; `false` — альтернативный.
synthetic	Type: boolean Признак автоматически созданного контакта: `true` — контакт создан автоматически; `false` — контакт создан вручную.
type	Type: string Тип контакта. Example: `example`
value	Type: string Значение контакта. Example: `example`

Example

{
  "type": "example",
  "value": "example",
  "main": true,
  "alias": true,
  "synthetic": true,
  "label": "example"
}

v1User

Сотрудник.

Name	Description
about	Type: string Описание сотрудника. Example: `example`
aliases	Type: string[] Список алиасов сотрудника. Example `[ "example" ]`
avatarId	Type: string Идентификатор портрета сотрудника. Example: `example`
birthday	Type: string Дата рождения сотрудника. В формате `YYYY-MM-DD` или пустая строка. Example: `example`
contacts	Type: v1UserContact[] Список контактов сотрудника. Example `[ { "type": "example", "value": "example", "main": true, "alias": true, "synthetic": true, "label": "example" } ]`
createdAt	Type: string<date-time> Дата и время создания сотрудника. Example: `2025-01-01T00:00:00Z`
departmentId	Type: integer Идентификатор подразделения, в котором состоит сотрудник.
email	Type: string Основной адрес электронной почты сотрудника. Example: `example`
externalId	Type: string Произвольный внешний идентификатор сотрудника. Example: `example`
gender	Type: string Пол сотрудника. Example: `example`
groups	Type: integer[] Идентификаторы групп, в которых состоит сотрудник. Example `[ 0 ]`
id	Type: string<uint64> Идентификатор сотрудника. Example: `example`
isAdmin	Type: boolean Признак администратора организации: `true` — администратор; `false` — рядовой пользователь.
isDismissed	Type: boolean Статус сотрудника: `true` — уволенный; `false` — действующий.
isEnabled	Type: boolean Статус аккаунта сотрудника: `true` — активен; `false` — заблокирован.
isEnabledUpdatedAt	Type: string<date-time> Дата и время последнего изменения статуса аккаунта сотрудника. Отсутствует если статус никогда не менялся. Example: `2025-01-01T00:00:00Z`
isRobot	Type: boolean Признак служебных сотрудников-ботов: `true` — бот; `false` — человек.
language	Type: string Язык сотрудника. Example: `example`
name	Type: v1UserName ФИО сотрудника. Example `{ "first": "example", "last": "example", "middle": "example" }`
nickname	Type: string Логин сотрудника. Example: `example`
position	Type: string Должность сотрудника. Example: `example`
timezone	Type: string Часовой пояс сотрудника. Example: `example`
updatedAt	Type: string<date-time> Дата и время изменения сотрудника. Example: `2025-01-01T00:00:00Z`

Example

{
  "id": "example",
  "nickname": "example",
  "departmentId": 0,
  "email": "example",
  "name": {
    "first": "example",
    "last": "example",
    "middle": "example"
  },
  "gender": "example",
  "position": "example",
  "avatarId": "example",
  "about": "example",
  "birthday": "example",
  "contacts": [
    {
      "type": "example",
      "value": "example",
      "main": true,
      "alias": true,
      "synthetic": true,
      "label": "example"
    }
  ],
  "aliases": [
    "example"
  ],
  "groups": [
    0
  ],
  "externalId": "example",
  "isAdmin": true,
  "isRobot": true,
  "isDismissed": true,
  "isEnabled": true,
  "isEnabledUpdatedAt": "2025-01-01T00:00:00Z",
  "timezone": "example",
  "language": "example",
  "createdAt": "2025-01-01T00:00:00Z",
  "updatedAt": "2025-01-01T00:00:00Z"
}

400 Bad Request

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

Body

application/json

{
  "code": 0,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}

Name	Description
code	Type: integer Код ошибки.
details	Type: protobufAny[] Дополнительные сведения об ошибке. Example `[ { "@type": "example" } ]`
message	Type: string Описание ошибки. Example: `example`

protobufAny

Name

Description

@type

Type: string

Example: example

[additional]

Type: unknown

Example: null

Example

{
  "@type": "example"
}

401 Unauthorized

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

Body

application/json

{
  "code": 0,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}

Name	Description
code	Type: integer Код ошибки.
details	Type: protobufAny[] Дополнительные сведения об ошибке. Example `[ { "@type": "example" } ]`
message	Type: string Описание ошибки. Example: `example`

403 Forbidden

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

Body

application/json

{
  "code": 0,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}

Name	Description
code	Type: integer Код ошибки.
details	Type: protobufAny[] Дополнительные сведения об ошибке. Example `[ { "@type": "example" } ]`
message	Type: string Описание ошибки. Example: `example`

404 Not Found

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

Body

application/json

{
  "code": 0,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}

Name	Description
code	Type: integer Код ошибки.
details	Type: protobufAny[] Дополнительные сведения об ошибке. Example `[ { "@type": "example" } ]`
message	Type: string Описание ошибки. Example: `example`

500 Internal Server Error

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

Body

application/json

{
  "code": 0,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}

Name	Description
code	Type: integer Код ошибки.
details	Type: protobufAny[] Дополнительные сведения об ошибке. Example `[ { "@type": "example" } ]`
message	Type: string Описание ошибки. Example: `example`

Была ли статья полезна?

Обзор

Добавить