---
metadata:
  - name: generator
    content: Diplodoc Platform v5.50.2
alternate:
  - https://yandex.com/dev/direct/doc/dg-v4/en/reference/GetClientsList.md
  - https://yandex.com/dev/direct/doc/dg-v4/ru/reference/GetClientsList.md
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.com/dev/direct/doc/dg-v4/ru/llms.txt

# GetClientsList
Возвращает учетные записи всех клиентов рекламного агентства.
Для метода существует версия [GetClientsList (Live)](https://yandex.ru/dev/direct/doc/dg-v4/live/GetClientsList.html).

Метод доступен только рекламным агентствам и не доступен прямым рекламодателям.


## Входные данные {#input}

Ниже показана структура входных данных в формате JSON.

```javascript
{
   "method": "GetClientsList",
   "param": {
      /* ClientInfoRequest */
      "Filter": {
         /* ClientFilter */
         "StatusArch": (string)
      }
   }
}
```

В параметре `param` указывают условия отбора клиентов, описанные ниже. Вызов без `param` возвращает данные всех клиентов.


#|
||
**<sup >Параметр</sup>**
|
**<sup >Описание</sup>**
|
**<sup >Требуется</sup>**
||

||
**<sub >Объект ClientInfoRequest</sub>**
||
||
`Filter`
|
Содержит объект `ClientFilter`, задающий условия отбора пользователей.
|
Нет
||

||
**<sub >Объект ClientFilter</sub>**
||
||
`StatusArch`
|
Значение Yes — отобрать пользователей, учетные записи которых помещены в архив. Значение No — отобрать только активных пользователей.
|
Нет
||
|#


## Результирующие данные {#output}

Ниже показана структура результирующих данных в формате JSON.

```javascript
{
   "data": [
      {  /* ClientInfo */
         "Login": (string),
         "DateCreate": (date),
         "Phone": (string),
         "FIO": (string),
         "Email": (string),
         "StatusArch": (string),
         "Discount": (float),
         "SmsPhone": (string),
         "CampaignEmails": [
            (string)
            ...
         ],
         "ClientRights": [
            {  /* ClientRight */
               "RightName": (string),
               "Value": (string),
            }
            ...
         ],
         "Role": (string),
         "NonResident": (string),
         "SendNews": (string),
         "SendAccNews": (string),
         "SendWarn": (string),
      }
      ...
   ]
}
```

Ниже приведено описание параметров.

<!-- source: ru/reference/_includes/reference/GetClientInfo/id-output/clientinfo.md -->
#|
||
**<sup >Параметр</sup>**
|
**<sup >Описание</sup>**
||

||
**<sub >Объект ClientInfo</sub>**
||
||
`Login`
|
Логин пользователя на Яндексе.
||
||
`Phone`
|
Контактный телефон в произвольном формате. Рекомендуется указывать номер в международном формате, например `+7(495)137-33-33`.
||
||
`DateCreate`
|
Дата регистрации пользователя, `YYYY-MM-DD`.
||
||
`FIO`
|
Фамилия и инициалы.
||
||
`Email`
|
Адрес электронной почты для отправки новостей и уведомлений.
||
||
`StatusArch`
|
Учетная запись пользователя помещена в архив (не активна) — Yes/No.
||
||
`Discount`
|
Персональная скидка. В настоящее время не применяется.
||
||
`SmsPhone`
|
Телефонный номер для отправки sms-уведомлений. Берется из учетной записи пользователя в Яндексе.
||
||
`CampaignEmails`
|
Массив адресов электронной почты всех кампаний пользователя.
||
||
`Role`
|
Роль в Яндекс Директе:

- Client — клиент рекламного агентства, или прямой рекламодатель, или представитель прямого рекламодателя;
- Agency — рекламное агентство или представитель агентства.
||
||
`NonResident`
|
Нерезидент — Yes/No.
||
||
`SendNews`
|
Сообщать о новостях Яндекс Директа — Yes/No.
||
||
`SendAccNews`
|
Сообщать о состоянии кампаний, обслуживаемых персональным менеджером в Яндексе, — Yes/No.
||
||
`SendWarn`
|
Сообщать о перемещении объявлений на более низкие позиции относительно желаемых — Yes/No.
||
||
`ClientRights`
|
Массив объектов `ClientRight`. Они определяют полномочия клиента рекламного агентства по управлению кампаниями, которые агентство создало для него.

Параметр доступен только для рекламных агентств.
||

||
**<sub >Объект ClientRight</sub>**
||
||
`RightName`
|
Название полномочий, которые предоставляются или отменяются:

- AllowEditCampaigns — разрешать изменение параметров кампаний;
- AllowTransferMoney — разрешать перевод средств между кампаниями;
- AllowImportXLS — разрешать загрузку данных из файлов MS Excel.
||
||
`Value`
|
Значение Yes — предоставить указанные полномочия, значение No — отменить.
||
|#
<!-- endsource: ru/reference/_includes/reference/GetClientInfo/id-output/clientinfo.md -->



## Примеры входных данных {#examples}

## Python

```python
{
   'Filter': {
      'StatusArch': 'No'
   }
}
```

## PHP

```php
array(
   'Filter' => array(
      'StatusArch' ='No'
   )
)
```

## Perl

```perl
{
   'Filter' ={
      'StatusArch' ='No'
   }
}
```