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

# GetSubClients
Возвращает список субклиентов указанного пользователя.
Для рекламного агентства возвращается список клиентов и представителей. Для прямого рекламодателя возвращается список представителей.


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

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

```javascript
{
   "method": "GetSubClients",
   "param": {
      /* GetSubClientsRequest */
      "Login": (string),
      "Filter": {
         /* ClientFilter */
         "StatusArch": (string)
      }
   }
}
```

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


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

||
**Объект GetSubClientsRequest**
||
||
`Login`
|
Логин пользователя Яндекса, для которого запрашивается список субклиентов.
|
да
||
||
`Filter`
|
Объект `ClientFilter`, задающий условия отбора субклиентов.
|
нет
||

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


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

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

```javascript
{
   "data": [
      {  /* ShortClientInfo */
         "Login": (string),
         "FIO": (string),
         "Role": (string)
      }
      ...
   ]
}
```

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


#|
||
**Объект ShortClientInfo**
||
||
`Login`
|
Логин пользователя на Яндексе.
||
||
`FIO`
|
Фамилия и инициалы.
||
||
`Role`
|
Роль субклиента:

- UnlimitedRepClient — представитель прямого рекламодателя.
- UnlimitedRepAgency — представитель агентства, который может управлять рекламными кампаниями любых клиентов;
- LimitedRepAgency — представитель агентства, который может управлять рекламными кампаниями определенных клиентов (список клиентов определяет главный представитель в веб-интерфейсе);
- ChiefRepSubClient — клиент агентства.
||
|#


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

## Python

```python
{
   'Login': 'agrom',
   'Filter': {
      'StatusArch': 'No'
   },
}
```

## PHP

```php
array(
   'Login' => 'agrom',
   'Filter' => array(
      'StatusArch' ='No'
   ),
)
```

## Perl

```perl
{
   'Login' => 'agrom',
   'Filter' ={
      'StatusArch' ='No'
   },
}
```