Просмотреть список участников команды

Внимание. Сервис Яндекс Коннект больше не поддерживается. Directory API прекратит работу с 1 апреля 2023 года. С 24 марта доступность сервиса будет ограничена.

Для управления организациями, пользователями и доменами используйте сервис Яндекс 360 для бизнеса.

Документация API 360

Запрос позволяет получить информацию об участниках определенной команды. В роли участников могут выступать отдельные сотрудники, команды или отделы.

Ограничение. Чтобы выполнить запрос, вашему приложению требуется разрешение на чтение данных о командах . Убедитесь, что вы указали его при настройке OAuth.

Формат запроса

Для получения списка отделов используйте HTTP-запрос с методом GET:

GET /v6/groups/<group_id>/members/
Host: https://api.directory.yandex.net
Authorization: OAuth <токен>
X-Org-ID: <идентификатор организации>
Accept: application/json
Ресурс
group_id

Идентификатор команды, информацию о которой необходимо получить.

Заголовки запроса
Host

Адрес узла, предоставляющего API:

https://api.directory.yandex.net
Authorization

OAuth-токен в формате OAuth <значение токена>, например:

OAuth 0c4181a7c2cf4521964a72ff57a34a07
X-Org-ID

Идентификатор организации. Заголовок необходимо передавать только если запрос выполняется от имени администратора нескольких организаций.

Accept

Допустимый формат ответа. Должен иметь значение application/json.

Формат ответа

В случае успешного выполнения запроса API возвращает ответ с кодом 200. Тело ответа содержит JSON-массив со списком участников:

[
  {
    "type": "user",
    "object": {
      "department_id": <идентификатор отдела>,
      "id": <идентификатор сотрудника>,
      "nickname": "<логин>",
      "email": "<основной email>",
      "gender": "<male|female>",
      "name": {
        "first": "<Имя>",
        "last": "<Фамилия>",
        "middle": "<отчество>"
      }
    }
  },
  ...
]
Параметры ответа
type

Тип участника команды:

  • user — сотрудник;

  • group — команда;

  • department — отдел.

object

Объект с информацией об участнике.

Поля объектов типа user:

Параметр Описание Тип данных
department_id

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

Целое число.

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

Целое число.

nickname

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

Строка

email

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

Строка.

gender

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

  • male — мужской;

  • female — женский

  • null — пол не указан.

Строка.

name Объект с информацией об имени сотрудника. Объект.
Поля объекта name
first

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

Строка.

last

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

Строка.

middle

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

Строка.

Параметр Описание Тип данных
department_id

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

Целое число.

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

Целое число.

nickname

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

Строка

email

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

Строка.

gender

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

  • male — мужской;

  • female — женский

  • null — пол не указан.

Строка.

name Объект с информацией об имени сотрудника. Объект.
Поля объекта name
first

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

Строка.

last

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

Строка.

middle

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

Строка.