---
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/en/llms.txt

# GetClientsList
Returns the accounts of all clients of the advertising agency.

{% 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 %}


The [GetClientsList (Live)](https://yandex.com/dev/direct/doc/dg-v4/en/live/GetClientsList.md) version also exists for this method.

This method is available only to advertising agencies, not to direct advertisers.


## Input data {#input}

The input data structure in JSON is shown below.

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

The `param` parameter is used for specifying the conditions for filtering clients, as described below. A call without `param` returns data for all clients.


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

||
**<sub >ClientInfoRequest object</sub>**
||
||
`Filter`
|
Contains the `ClientFilter` object that sets user filter conditions.
|
No
||

||
**<sub >ClientFilter object</sub>**
||
||
`StatusArch`
|
Yes — Select only users whose accounts are archived. No — Select only active users.
|
No
||
|#


## Output data {#output}

The output data structure in JSON is shown below.

```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),
      }
      ...
   ]
}
```

Parameters are described below.


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

||
**<sub >ClientInfo object</sub>**
||
||
`Login`
|
The Yandex username.
||
||
`Phone`
|
Contact phone number in any format. We recommend using international phone number format, for example: `+7(495)137-33-33`.
||
||
`DateCreate`
|
Date of user registration, `YYYY-MM-DD`.
||
||
`FIO`
|
Last name and initials.
||
||
`Email`
|
The email address to send notifications and news to.
||
||
`StatusArch`
|
The user's account is archived (inactive) — Yes/No.
||
||
`Discount`
|
Personal discount. Currently not used.
||
||
`SmsPhone`
|
Phone number for sending SMS notifications to. Taken from the user's Yandex account.
||
||
`CampaignEmails`
|
Array of email addresses for all the user's campaigns.
||
||
`Role`
|
Role in Yandex Direct:

- Client — The client of an advertising agency, or a direct advertiser, or the representative of a direct advertiser.
- Agency — An advertising agency or representative of an agency.
||
||
`NonResident`
|
Non-resident — Yes/No.
||
||
`SendNews`
|
Send Yandex Direct news — Yes/No.
||
||
`SendAccNews`
|
Send status notifications for campaigns that have a personal Yandex manager — Yes/No.
||
||
`SendWarn`
|
Send a notification when ads are moved to lower positions than desired — Yes/No.
||
||
`ClientRights`
|
Array of `ClientRight` objects. They define the rights of an advertising agency's client for managing campaigns that the agency created for this client.

This parameter is only available to advertising agencies.
||

||
**<sub >ClientRight object</sub>**
||
||
`RightName`
|
Name of the permission that is being granted or revoked:

- AllowEditCampaigns — allow making changes to campaign parameters.
- AllowTransferMoney — allow transferring funds between campaigns.
- AllowImportXLS — allow downloading data from MS Excel files.
||
||
`Value`
|
Yes indicates granting the specified rights, and No indicates revoking them.
||
|#


## Examples of input data {#examples}

## Python

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

## PHP

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

## Perl

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