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

# GetSubClients
Returns a list of subclients of the specified user.

{% note alert %}

Disabled method. Use version 5 of the API.

For information about the compatibility of methods between versions 4 and 5, see the [Migration guide](https://yandex.com/dev/direct/doc/migration/concepts/methods.md).

{% endnote %}


For an advertising agency, returns a list of clients and delegates. For a direct advertiser, returns a list of delegates.


## Input data {#input}

The input data structure in JSON is shown below.

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

Parameters are described below.


#|
||
**<sup >Parameter</sup>**
|
**<sup >Description</sup>**
|
**<sup >Required</sup>**
||

||
**GetSubClientsRequest object**
||
||
`Login`
|
Username of the Yandex user that the list of subclients is requested for.
|
yes
||
||
`Filter`
|
The `ClientFilter` object, which sets conditions for filtering subclients.
|
no
||

||
**ClientFilter object**
||
||
`StatusArch`
|
Yes — Select only subclients whose accounts are archived. No — Select only active subclients.
|
yes
||
|#


## Output data {#output}

Returns an array of `ShortClientInfo` objects with data for associated subclients. The output data structure in JSON is shown below.

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

Parameters are described below.


#|
||
**ShortClientInfo object**
||
||
`Login`
|
The Yandex username.
||
||
`FIO`
|
Last name and initials.
||
||
`Role`
|
Subclient's role:

- UnlimitedRepClient — Representative of a direct advertiser.
- UnlimitedRepAgency — Agency delegate who can manage advertising campaigns for any clients.
- LimitedRepAgency — Agency delegate who can manage the advertising campaigns of specific clients (the chief representative defines the list of clients in the web interface).
- ChiefRepSubClient — Agency client.
||
|#


## Examples of input data {#examples}

## Python

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

## PHP

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

## Perl

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