---
metadata:
  - name: generator
    content: Diplodoc Platform v5.54.5
  - property: og:type
    content: article
  - property: article:section
    content: Справочник API
  - property: og:title
    content: Получить информацию о пользователях
  - property: article:tag
    content: Техническая инструкция
alternate:
  - https://yandex.ru/support/tracker/en/api-ref/users/get-users.md
  - https://yandex.ru/support/tracker/ru/api-ref/users/get-users.md
  - href: ru/api-ref/users/get-users.md
    type: text/markdown
    title: Markdown version
  - href: ../../llms.txt
    type: text/markdown
    title: llms.txt
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.ru/support/tracker/ru/llms.txt


# Получить информацию о пользователях

Запрос позволяет получить информацию об учетных записях пользователей, которые зарегистрированы в организации. Результат запроса отображается [постранично](https://yandex.ru/support/tracker/ru/api-ref/common-format.md#displaying-results).

{% note warning "Ограничение" %}

Данный запрос имеет ограничение в 10 000 пользователей. Для получения большего количества пользователей используйте [метод с относительной пагинацией](https://yandex.ru/support/tracker/ru/api-ref/users/get-users-relative.md).

{% endnote %}

<div class="request_example method_get yfm-clipboard">
    <p>GET</p>
    <pre><code>https://api.tracker.yandex.net/v3/users?expand=groups</code></pre>
    <button class="yfm-clipboard-button"><svg width="16" height="16" viewBox="0 0 24 24" class="yfm-clipboard-icon" data-animation="15">
    <path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path>
    <path stroke="currentColor" fill="transparent" strokewidth="1.5" d="M9.5 13l3 3l5 -5" visibility="hidden">
        <animate id="visibileAnimation-15" attributeName="visibility" from="hidden" to="visible" dur="0.2s" fill="freeze" begin=""></animate>
        <animate id="hideAnimation-15" attributeName="visibility" from="visible" to="hidden" dur="1s" begin="visibileAnimation-15.end+1" fill="freeze"></animate>
    </path>
</svg>
</button>
</div>

<!-- source: ru/api-ref/_assets/style/methods.md -->

<!-- endsource: ru/api-ref/_assets/style/methods.md -->

## Формат запроса {#query}

Перед выполнением запроса [получите доступ к API](https://yandex.ru/support/tracker/ru/api-ref/access.md).

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

```json translate=no
GET /v3/users
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>
```

<!-- source: ru/api-ref/_includes/headings-no-body.md -->
{% cut "Заголовки" %}

* `Host`: адрес узла, предоставляющего API.

* <!-- source: ru/api-ref/_includes/authorization.md -->
  `Authorization`: токен для авторизации в одном из форматов:

    - `OAuth <OAuth-токен>` при авторизации по протоколу OAuth 2.0. [Читать подробнее](https://yandex.ru/support/tracker/ru/api-ref/access.md#about_OAuth)

    - `Bearer <IAM-токен>` при авторизации с помощью IAM-токена — если к Трекеру привязана организация Yandex Identity Hub. [Читать подробнее](https://yandex.ru/support/tracker/ru/api-ref/access.md#iam-token)
  <!-- endsource: ru/api-ref/_includes/authorization.md -->


* <!-- source: ru/api-ref/_includes/org-id.md -->
  `X-Org-ID` или `X-Cloud-Org-ID`: идентификатор организации.

  - если к Трекеру привязана организация Яндекс 360 для бизнеса, используйте заголовок `X-Org-ID`,

  - если к Трекеру привязана организация Yandex Identity Hub, используйте заголовок `X-Cloud-Org-ID`.
  <!-- endsource: ru/api-ref/_includes/org-id.md -->

  <!-- source: ru/api-ref/_includes/org-id.md -->
  Чтобы узнать идентификатор организации, перейдите на страницу **Администрирование** → [**Организации**](https://tracker.yandex.ru/admin/orgs) и скопируйте значение поля **идентификатор**.
  <!-- endsource: ru/api-ref/_includes/org-id.md -->


{% endcut %}
<!-- endsource: ru/api-ref/_includes/headings-no-body.md -->

{% cut "Параметры запроса" %}

**Дополнительные параметры**

Параметр | Описание | Тип данных
-------- | -------- | ----------
perPage | Количество элементов на странице. От 1 до 100 включительно. | Число
id | Идентификатор пользователя (uid), начиная с которого нужно искать. | Число
email | Фильтрация пользователей по электронной почте. Возвращает пользователя, чей email совпадает с указанным значением.| Строка
group | Фильтрация пользователей по идентификатору группы. Возвращает пользователей, которые входят в указанную группу. | Число
expand | Дополнительная информация, которая будет включена в ответ:<ul><li>`groups` — группы, в которые входят пользователи</li></ul> | Строка

{% endcut %}

**Примеры запросов:**

> Пример 1: Запросить информацию о пользователях, включая данные о группах, в которые они входят.
>
> ```json translate=no
> GET /v3/users?expand=groups
> Host: api.tracker.yandex.net
> Authorization: OAuth y0__xAbc******
> X-Org-ID: 1234******
> ```

> Пример 2: Найти пользователей по электронной почте.
>
> ```json translate=no
> GET /v3/users?email=username@example.com
> Host: api.tracker.yandex.net
> Authorization: OAuth y0__xAbc******
> X-Cloud-Org-ID: ab1c******
> ```

> Пример 3: Получить информацию о пользователях из определенной группы с информацией о группах.
>
> ```json translate=no
> GET /v3/users?group=5&expand=groups
> Host: api.tracker.yandex.net
> Authorization: OAuth y0__xAbc******
> X-Org-ID: 1234******
> ```

## Формат ответа {#answer}

{% list tabs %}

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

    <!-- source: ru/api-ref/_includes/answer-200.md -->
    В случае успешного выполнения запроса API возвращает ответ с кодом `200 OK`.
    <!-- endsource: ru/api-ref/_includes/answer-200.md -->

    Тело ответа содержит JSON-массив с параметрами пользователей.


    ```json translate=no
       [
          {
          "self": "https://api.tracker.yandex.net/v3/users/12********",
          "uid": 12********,
          "login": "username",
          "trackerUid": 12********,
          "passportUid": 12********,
          "cloudUid": "bfbdrb1aa248********",
          "firstName": "Имя",
          "lastName": "Фамилия",
          "display": "Имя Фамилия",
          "email": "mail@example.com",
          "groups": [
              {
                  "self": "https://api.tracker.yandex.net/v3/groups/5",
                  "id": "5",
                  "display": "Developers"
              }
          ],
          "external": false,
          "hasLicense": true,
          "dismissed": false,
          "useNewFilters": true,
          "disableNotifications": false,
          "firstLoginDate": "2019-08-22T14:56:57.981+0000",
          "lastLoginDate": "2022-06-22T17:44:32.981+0000",
          "welcomeMailSent": true
          },
        ...
       ]
    ```


    {% cut "Параметры ответа" %}

    Параметр | Описание | Тип данных
    -------- | -------- | ----------
    self | Адрес ресурса API, который содержит информацию об учетной записи пользователя. | Строка
    uid | Уникальный идентификатор учетной записи пользователя в Трекере. | Число
    login | Логин пользователя. | Строка
    trackerUid | Уникальный идентификатор аккаунта пользователя в Трекере. | Число
    passportUid | Уникальный идентификатор аккаунта пользователя в организации Яндекс 360 для бизнеса и Яндекс ID. | Число
    cloudUid | Уникальный идентификатор пользователя в Yandex Identity Hub. | Строка
    firstName | Имя пользователя. | Строка
    lastName | Фамилия пользователя. | Строка
    display | Отображаемое имя пользователя. | Строка
    email | Электронная почта пользователя. | Строка
    [groups](#groups) | Группы, в которые входит пользователь. Присутствует в ответе, если в запросе для параметра `expand` указано значение `groups`. | Массив объектов
    external | Служебный параметр. | Логический
    hasLicense | Признак наличия у пользователя полного доступа к Трекеру:<ul><li>`true` — полный доступ;</li><li>`false` — только чтение.</li></ul> | Логический
    dismissed | Статус пользователя в организации:<ul><li>`true` — пользователь удален из организации;</li><li>`false` — действующий сотрудник организации.</li></ul> | Логический
    useNewFilters | Служебный параметр. | Логический
    disableNotifications | Признак принудительного отключения уведомлений для пользователя:<ul><li>`true` — уведомления отключены;</li><li>`false` — уведомления включены.</li></ul> | Логический
    firstLoginDate | Дата и время первой авторизации пользователя в Трекере. Формат: `YYYY-MM-DDThh:mm:ss.sss±hhmm`. | Строка
    lastLoginDate | Дата и время последней авторизации пользователя в Трекере. Формат: `YYYY-MM-DDThh:mm:ss.sss±hhmm`. | Строка
    welcomeMailSent | Способ добавления пользователя: <ul><li>`true` — с помощью приглашения на почту;</li><li>`false` — другим способом.</li></ul>. | Логический


    **Параметры объектов в массиве `groups`** {#groups}

    Параметр | Описание | Тип данных
    -------- | -------- | ----------
    self | Адрес ресурса API, который содержит информацию о группе. | Строка
    id | Идентификатор группы. | Строка
    display | Отображаемое имя группы. | Строка

    {% endcut %}

- Запрос выполнен с ошибкой

    <!-- source: ru/api-ref/_includes/answer-error-401.md -->
    401
    :   Пользователь не авторизован. Проверьте, были ли выполнены действия, описанные в разделе [Доступ к API](https://yandex.ru/support/tracker/ru/api-ref/access.md).
    <!-- endsource: ru/api-ref/_includes/answer-error-401.md -->

    <!-- source: ru/api-ref/_includes/answer-error-403.md -->
    403
    :   У вас не хватает прав на выполнение этого действия. Наличие прав можно перепроверить в интерфейсе Трекера — для выполнения действия при помощи API и через интерфейс требуются одинаковые права.
    <!-- endsource: ru/api-ref/_includes/answer-error-403.md -->

{% endlist %}