---
metadata:
  - name: generator
    content: Diplodoc Platform v5.50.3
alternate:
  - https://yandex.com/dev/partner-objects/doc/en/reference/get-resource-id.md
  - https://yandex.com/dev/partner-objects/doc/ru/reference/get-resource-id.md
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.com/dev/partner-objects/doc/ru/llms.txt


# GET/{resource-id}

Возвращает список объектов указанного ресурса.

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

```
GET https://jsonapi.partner2.yandex.com/vX
  ? [fields[{resource-id}]=<string>]
  & [page[size]=<integer>]
  & [page[number]=<integer>]
  & [filter=<string>]
  & [include=<string>]
```

#|
|| **Параметр** | **Описание** ||
|| `resource-id`
| Идентификатор ресурса, для которого необходимо получить информацию.
||
|| `fields[{resource-id}]`
|

<!-- source: ru/_includes/fields-resource-id.md -->
Параметры, доступные для объектов. Допустимые значения:

- `actions` — действия, допустимые для текущего объекта;

- `block_type` — тип рекламного блока;

- `brands` — бренды, установленные на текущем объекте;

- `client_id` — идентификатор клиента;

- `dsp_blocks` – размер блока медийной рекламы. Для полноэкранных и rewarded блоков поле указывать не нужно.

- `editable_fields` — параметры текущего объекта, которые можно редактировать;

- `email` — электронная почта клиента;

- `excluded_domains` — исключенные домены;

- `excluded_phones` — исключенные телефоны;

- `formats_setup_mode` — настройки формата. Допустимые значения:

    - standard — форматы блоков настраиваются автоматически с параметрами по умолчанию;

    - manual — форматы блоков настраиваются в параметре `design_templates`.
    
- `geo` — региональные таргетинги, установленные на текущем объекте;

- `lang` — язык интерфейса;

- `lastname` — фамилия клиента;

- `level` — уровень вложенности;

- `login` — логин пользователя;

- `midname` — отчество пользователя;

- `multistate` — текущий статус объекта;

- `multistate_name` — текстовое описание статуса объекта;

- `name` — имя объекта;

- `page_id` — идентификатор площадки;

- `parent_id` — идентификатор родительского объекта;

- `regularity` — порядок сортировки в интерфейсе;

- `roles` — роли пользователя;

- `status` — статус объекта. Допустимые значения:

    - sync — синхронизирован;

    - pending — отправляется.
    
- `tech_type` — поле для работы с блоками для Turbo и AMP страниц. Применимо только для `"block_type" : "banner"`. Допустимые значения:

    - turbo — блок для Turbo;
    
    - amp — блок для AMP.
    

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

Допустимые значения зависят от ресурса и перечислены в параметре `available_fields` операции [GET/resources](https://yandex.com/dev/partner-objects/doc/ru/reference/get-resources.md).

{% endnote %}

Чтобы включить в запрос несколько допустимых значений, перечислите их через запятую.

<!-- взято из get-resource-id.md -->
<!-- endsource: ru/_includes/fields-resource-id.md -->

||
|| `page[size]`
| Количество объектов ресурса, которое необходимо включить в ответ. Значение по умолчанию: 100. Максимальное значение: 1000.
||
|| `page[number]`
| Номер страницы, с которой необходимо начать вывод.
||
|| `filter`
| Фильтр. Допустимые значения фильтров приведены в параметре `filters` операции [GET/{resource-id}](https://yandex.com/dev/partner-objects/doc/ru/reference/get-resource-id.md). Подробнее о фильтрах в разделе [Построение фильтров](https://yandex.com/dev/partner-objects/doc/ru/concepts/filters.md).

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

Фильтры доступны не для всех ресурсов.

{% endnote %}
||
|| `include`
|

<!-- source: ru/_includes/include-resource-id.md -->
Идентификатор связанного ресурса. В ответе будет дополнительная информация о связанном ресурсе.

{% note info %}

Чтобы включить в запрос несколько связанных ресурсов, перечислите их идентификаторы через запятую.

{% endnote %}

<!-- взято из get-resource-id.md -->
<!-- endsource: ru/_includes/include-resource-id.md -->

||
|#


Общая структура ответа приведена ниже. Порядок следования элементов не гарантируется. В структуре могут присутствовать служебные параметры, которые не описаны в таблице.


## Формат ответа {#output-structure}

## JSON

<!--"cpm": {integer} (после "blocked": {boolean})-->
```json
 {
  "included":
  [
    {
      "relationships": {
        "{string}": {
          "links": {
            "related": "{string}",
            "self": "{string}"
          }
        },
        ...
      },
      "id": "{string}",
      "type": "{string}",
      "attributes": {
        "actions": {...},
        "brands": [
          {
            "bid": "{string}",
            "blocked": {boolean}
            
          },
          {
            ...
          }
        ],
        "client_id": {integer},
        "email": "{string}",
        "excluded_domains": ["{string}"],
        "excluded_phones": ["{string}"],
        "geo": [
          {
            "id": "{string}",
            "cpm": {integer}
          },
          {
            ...
          }
        ],
        "lang": "{string}",
        "lastname": "{string}",
        "level": {integer},
        "login": "{string}",
        "midname": "{string}",
        "multistate": {integer},
        "multistate_name": "{string}",
        "name": "{string}",
        "page_id": {integer},
        "parent_id": {integer},
        "regularity": {integer},
        "roles": "{string}",
        "status": "{string}"
      },
      "links": {
        "self": "{string}"
      }
    }
  ],
  "data": [
    {
      "relationships": {
        "{string}": {
          "links": {
            "related": "{string}",
            "self": "{string}"
          }
        },
        ...
      },
      "id": "{string}",
      "type": "{string}",
      "attributes": {
      },
      "links": {
        "self": "{string}"
      }
    }
  ],
  "links": {
    "first": "{string}",
    "next": "{string}",
    "prev": "{string}",
    "self": "{string}",
    "last": "{string}"
  },
  "meta": {
    "found_rows": {integer},
    "count": {integer},
    "fields": [
      "{string}",
      "{string}"
    ],
    "filters": 
    [
      {
        "name": "{string}",
        "values":
        [
          {
            "label": "{string}",
            "id": "{string}"
          },
          {
            ...
          }
        ],
        "label": "{string}",
        "type": "{string}"
      }
    ]
  }
}      
```

## Параметры ответа {#spec-output}

- **included** Массив объектов связанного указанного ресурса.

  - **relationships** Связанные ресурсы и объекты.

    - **links** Ссылки на объекты, связанные с текущим объектом.

      - **related** Ссылка на список связанных объектов с параметрами.

      - **self** Ссылка на список связанных объектов.

  - **id** Идентификатор объекта.

  - **type** Тип ресурса.

  - **attributes** Массив параметров объекта. Список параметров зависит от типа ресурса. Ниже, для примера, приведена часть параметров.

    - **actions** Действия, допустимые для текущего объекта.

    - **brands** Бренды, установленные на текущем объекте.

      - **bid** Минимальная ставка, необходимая для показа бренда (в рублях).

      - **blocked** Бренд заблокирован (`true` или `false`).

    - **client_id** Идентификатор клиента.

    - **editable_fields** Параметры текущего объекта, которые можно редактировать.

    - **email** Электронная почта клиента.

    - **excluded_domains** Исключенные домены.

    - **excluded_phones** Исключенные телефоны.

    - **geo** Региональные таргетинги, установленные на текущем объекте.

      - **id** Идентификатор региона. Узнать регион можно с помощью операции [GET/{resource-id}](https://yandex.com/dev/partner-objects/doc/ru/reference/get-resource-id.md).

      - **cpm** Минимальный CPM, необходимый для показа в текущем регионе (в рублях).

    - **lang** Язык интерфейса.

    - **lastname** Фамилия клиента.

    - **level** Уровень вложенности.

    - **login** Логин пользователя.

    - **midname** Отчество пользователя.

    - **multistate** Текущий статус объекта.

    - **multistate_name** Текстовое описание статуса объекта.

    - **name** Имя объекта.

    - **page_id** Идентификатор площадки.

    - **parent_id** Идентификатор родительского объекта.

    - **regularity** Порядок сортировки в интерфейсе.

    - **roles** Роли пользователя.

    - **status** Статус объекта. Допустимые значения:

      &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;- **sync** — синхронизирован;

      &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;- **pending** — отправляется.

  - **links** Ссылки, связанные с объектом.

    - **self** Ссылка на текущий объект.

- **data** Массив объектов указанного ресурса.

  - **relationships** Связанные ресурсы и объекты.

    - **links** Ссылки на объекты, связанные с текущим объектом.

      - **related** Ссылка на список связанных объектов с параметрами.

      - **self** Ссылка на список связанных объектов.

  - **id** Идентификатор объекта.

  - **type** Тип ресурса.

  - **attributes** Массив параметров объекта. Список параметров зависит от типа ресурса. Ниже, для примера, приведена часть параметров.

    - **actions** Действия, допустимые для текущего объекта.

    - **brands** Бренды, установленные на текущем объекте.

      - **bid** Минимальная ставка, необходимая для показа бренда (в рублях).

      - **blocked** Бренд заблокирован (`true` или `false`).

    - **client_id** Идентификатор клиента.

    - **editable_fields** Параметры текущего объекта, которые можно редактировать.

    - **email** Электронная почта клиента.

    - **excluded_domains** Исключенные домены.

    - **excluded_phones** Исключенные телефоны.

    - **geo** Региональные таргетинги, установленные на текущем объекте.

      - **id** Идентификатор региона. Узнать регион можно с помощью операции [GET/{resource-id}](https://yandex.com/dev/partner-objects/doc/ru/reference/get-resource-id.md).

      - **cpm** Минимальный CPM, необходимый для показа в текущем регионе (в рублях).

    - **lang** Язык интерфейса.

    - **lastname** Фамилия клиента.

    - **level** Уровень вложенности.

    - **login** Логин пользователя.

    - **midname** Отчество пользователя.

    - **multistate** Текущий статус объекта.

    - **multistate_name** Текстовое описание статуса объекта.

    - **name** Имя объекта.

    - **page_id** Идентификатор площадки.

    - **parent_id** Идентификатор родительского объекта.

    - **regularity** Порядок сортировки в интерфейсе.

    - **roles** Роли пользователя.

    - **status** Статус объекта. Допустимые значения:

      &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;- **sync** — синхронизирован;

      &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;- **pending** — отправляется.

  - **links** Ссылки, связанные с объектом.

    - **self** Ссылка на текущий объект.

- **links** Постраничные ссылки.

  - **first** Ссылка на первую страницу.

  - **next** Ссылка на следующую страницу.

  - **prev** Ссылка на предыдущую страницу.

  - **self** Ссылка на текущую страницу.

  - **last** Ссылка на последнюю страницу.

- **meta** Объект содержит метаинформацию.

  - **found_rows** Общее количество объектов.

  - **count** Количество объектов в ответе.

  - **fields** Массив запрошенных параметров.

  - **filters** Фильтры, которые можно применить к объектам указанного ресурса. Подробнее о фильтрах в разделе [Построение фильтров](https://yandex.com/dev/partner-objects/doc/ru/concepts/filters.md).

    - **name** Название параметра.

    - **values** Допустимые значения параметра. Используются для построения фильтра.

      - **label** Название параметра в интерфейсе.

      - **id** Идентификатор значения фильтра.

    - **label** Название параметра в интерфейсе.

    - **type** Тип параметра. Помогает определить какие операторы можно использовать для построения фильтра.


<!--
```
<tree ><tree-item id="included-element"><tree-itemname >included</tree-itemname><tree-itemdesc > Массив объектов связанного указанного ресурса. </tree-itemdesc><tree-item id="relationships"><tree-itemname >relationships</tree-itemname><tree-itemdesc > Связанные ресурсы и объекты. </tree-itemdesc><tree-item ><tree-itemname >links</tree-itemname><tree-itemdesc > Ссылки на объекты, связанные с текущим объектом. </tree-itemdesc><tree-item ><tree-itemname >related</tree-itemname><tree-itemdesc > Ссылка на список связанных объектов с параметрами. </tree-itemdesc></tree-item><tree-item ><tree-itemname >self</tree-itemname><tree-itemdesc > Ссылка на список связанных объектов. </tree-itemdesc></tree-item></tree-item></tree-item><tree-item id="id-data"><tree-itemname >id</tree-itemname><tree-itemdesc > Идентификатор объекта. </tree-itemdesc></tree-item><tree-item ><tree-itemname >type</tree-itemname><tree-itemdesc > Тип ресурса. </tree-itemdesc></tree-item><tree-item id="attributes-def"><tree-itemname >attributes</tree-itemname><tree-itemdesc > Массив параметров объекта. Список параметров зависит от типа ресурса. Ниже, для примера, приведена часть параметров.</tree-itemdesc><tree-item ><tree-itemname >actions</tree-itemname><tree-itemdesc > Действия, допустимые для текущего объекта. </tree-itemdesc></tree-item><tree-item ><tree-itemname >brands</tree-itemname><tree-itemdesc > Бренды, установленные на текущем объекте. </tree-itemdesc><tree-item ><tree-itemname >bid</tree-itemname><tree-itemdesc > Минимальная ставка, необходимая для показа бренда (в рублях). </tree-itemdesc></tree-item><tree-item ><tree-itemname >blocked</tree-itemname><tree-itemdesc > Бренд заблокирован (`true` или `false`).
```
--> 

<!--<tree-item><tree-itemname>cpm</tree-itemname><tree-itemdesc>
                              Минимальный CPM, необходимый для показа бренда (в рублях).
                            </tree-itemdesc></tree-item>-->

<!--
```
</tree-itemdesc></tree-item></tree-item><tree-item ><tree-itemname >client_id</tree-itemname><tree-itemdesc > Идентификатор клиента. </tree-itemdesc></tree-item><tree-item ><tree-itemname >editable_fields</tree-itemname><tree-itemdesc > Параметры текущего объекта, которые можно редактировать. </tree-itemdesc></tree-item><tree-item ><tree-itemname >email</tree-itemname><tree-itemdesc > Электронная почта клиента. </tree-itemdesc></tree-item><tree-item ><tree-itemname >excluded_domains</tree-itemname><tree-itemdesc > Исключенные домены. </tree-itemdesc></tree-item><tree-item ><tree-itemname >excluded_phones</tree-itemname><tree-itemdesc > Исключенные телефоны. </tree-itemdesc></tree-item><tree-item ><tree-itemname >geo</tree-itemname><tree-itemdesc > Региональные таргетинги, установленные на текущем объекте. </tree-itemdesc><tree-item ><tree-itemname >id</tree-itemname><tree-itemdesc id="geo-id"> Идентификатор региона. Узнать регион можно с помощью операции [GET/{resource-id}](get-resource-id.md). </tree-itemdesc></tree-item><tree-item ><tree-itemname >cpm</tree-itemname><tree-itemdesc > Минимальный CPM, необходимый для показа в текущем регионе (в рублях). </tree-itemdesc></tree-item></tree-item><tree-item ><tree-itemname >lang</tree-itemname><tree-itemdesc > Язык интерфейса. </tree-itemdesc></tree-item><tree-item ><tree-itemname >lastname</tree-itemname><tree-itemdesc > Фамилия клиента. </tree-itemdesc></tree-item><tree-item ><tree-itemname >level</tree-itemname><tree-itemdesc > Уровень вложенности. </tree-itemdesc></tree-item><tree-item ><tree-itemname >login</tree-itemname><tree-itemdesc > Логин пользователя. </tree-itemdesc></tree-item><tree-item ><tree-itemname >midname</tree-itemname><tree-itemdesc > Отчество пользователя. </tree-itemdesc></tree-item><tree-item ><tree-itemname >multistate</tree-itemname><tree-itemdesc > Текущий статус объекта. </tree-itemdesc></tree-item><tree-item ><tree-itemname >multistate_name</tree-itemname><tree-itemdesc > Текстовое описание статуса объекта. </tree-itemdesc></tree-item><tree-item ><tree-itemname >name</tree-itemname><tree-itemdesc > Имя объекта. </tree-itemdesc></tree-item><tree-item ><tree-itemname >page_id</tree-itemname><tree-itemdesc > Идентификатор площадки. </tree-itemdesc></tree-item><tree-item ><tree-itemname >parent_id</tree-itemname><tree-itemdesc > Идентификатор родительского объекта. </tree-itemdesc></tree-item><tree-item ><tree-itemname >regularity</tree-itemname><tree-itemdesc > Порядок сортировки в интерфейсе. </tree-itemdesc></tree-item><tree-item ><tree-itemname >roles</tree-itemname><tree-itemdesc > Роли пользователя. </tree-itemdesc></tree-item><tree-item ><tree-itemname >status</tree-itemname><tree-itemdesc > Статус объекта. Допустимые значения: 
- sync — синхронизирован;
- pending — отправляется.
</tree-itemdesc></tree-item></tree-item><tree-item id="links-self"><tree-itemname >links</tree-itemname><tree-itemdesc id="links"> Ссылки, связанные с объектом. </tree-itemdesc><tree-item ><tree-itemname >self</tree-itemname><tree-itemdesc id="self"> Ссылка на текущий объект. </tree-itemdesc></tree-item></tree-item></tree-item><tree-item id="id-def"><tree-itemname >data</tree-itemname><tree-itemdesc > Массив объектов указанного ресурса. </tree-itemdesc><tree-item id="relationships"><tree-itemname >relationships</tree-itemname><tree-itemdesc > Связанные ресурсы и объекты. </tree-itemdesc><tree-item ><tree-itemname >links</tree-itemname><tree-itemdesc > Ссылки на объекты, связанные с текущим объектом. </tree-itemdesc><tree-item ><tree-itemname >related</tree-itemname><tree-itemdesc > Ссылка на список связанных объектов с параметрами. </tree-itemdesc></tree-item><tree-item ><tree-itemname >self</tree-itemname><tree-itemdesc > Ссылка на список связанных объектов. </tree-itemdesc></tree-item></tree-item></tree-item><tree-item id="id-data"><tree-itemname >id</tree-itemname><tree-itemdesc > Идентификатор объекта. </tree-itemdesc></tree-item><tree-item ><tree-itemname >type</tree-itemname><tree-itemdesc > Тип ресурса. </tree-itemdesc></tree-item><tree-item id="attributes-def"><tree-itemname >attributes</tree-itemname><tree-itemdesc > Массив параметров объекта. Список параметров зависит от типа ресурса. Ниже, для примера, приведена часть параметров.</tree-itemdesc><tree-item ><tree-itemname >actions</tree-itemname><tree-itemdesc > Действия, допустимые для текущего объекта. </tree-itemdesc></tree-item><tree-item ><tree-itemname >brands</tree-itemname><tree-itemdesc > Бренды, установленные на текущем объекте. </tree-itemdesc><tree-item ><tree-itemname >bid</tree-itemname><tree-itemdesc > Минимальная ставка, необходимая для показа бренда (в рублях). </tree-itemdesc></tree-item><tree-item ><tree-itemname >blocked</tree-itemname><tree-itemdesc > Бренд заблокирован (`true` или `false`). </tree-itemdesc></tree-item></tree-item><tree-item ><tree-itemname >client_id</tree-itemname><tree-itemdesc > Идентификатор клиента. </tree-itemdesc></tree-item><tree-item ><tree-itemname >editable_fields</tree-itemname><tree-itemdesc > Параметры текущего объекта, которые можно редактировать. </tree-itemdesc></tree-item><tree-item ><tree-itemname >email</tree-itemname><tree-itemdesc > Электронная почта клиента. </tree-itemdesc></tree-item><tree-item ><tree-itemname >excluded_domains</tree-itemname><tree-itemdesc > Исключенные домены. </tree-itemdesc></tree-item><tree-item ><tree-itemname >excluded_phones</tree-itemname><tree-itemdesc > Исключенные телефоны. </tree-itemdesc></tree-item><tree-item ><tree-itemname >geo</tree-itemname><tree-itemdesc > Региональные таргетинги, установленные на текущем объекте. </tree-itemdesc><tree-item ><tree-itemname >id</tree-itemname><tree-itemdesc id="geo-id"> Идентификатор региона. Узнать регион можно с помощью операции [GET/{resource-id}](get-resource-id.md). </tree-itemdesc></tree-item><tree-item ><tree-itemname >cpm</tree-itemname><tree-itemdesc > Минимальный CPM, необходимый для показа в текущем регионе (в рублях). </tree-itemdesc></tree-item></tree-item><tree-item ><tree-itemname >lang</tree-itemname><tree-itemdesc > Язык интерфейса. </tree-itemdesc></tree-item><tree-item ><tree-itemname >lastname</tree-itemname><tree-itemdesc > Фамилия клиента. </tree-itemdesc></tree-item><tree-item ><tree-itemname >level</tree-itemname><tree-itemdesc > Уровень вложенности. </tree-itemdesc></tree-item><tree-item ><tree-itemname >login</tree-itemname><tree-itemdesc > Логин пользователя. </tree-itemdesc></tree-item><tree-item ><tree-itemname >midname</tree-itemname><tree-itemdesc > Отчество пользователя. </tree-itemdesc></tree-item><tree-item ><tree-itemname >multistate</tree-itemname><tree-itemdesc > Текущий статус объекта. </tree-itemdesc></tree-item><tree-item ><tree-itemname >multistate_name</tree-itemname><tree-itemdesc > Текстовое описание статуса объекта. </tree-itemdesc></tree-item><tree-item ><tree-itemname >name</tree-itemname><tree-itemdesc > Имя объекта. </tree-itemdesc></tree-item><tree-item ><tree-itemname >page_id</tree-itemname><tree-itemdesc > Идентификатор площадки. </tree-itemdesc></tree-item><tree-item ><tree-itemname >parent_id</tree-itemname><tree-itemdesc > Идентификатор родительского объекта. </tree-itemdesc></tree-item><tree-item ><tree-itemname >regularity</tree-itemname><tree-itemdesc > Порядок сортировки в интерфейсе. </tree-itemdesc></tree-item><tree-item ><tree-itemname >roles</tree-itemname><tree-itemdesc > Роли пользователя. </tree-itemdesc></tree-item><tree-item ><tree-itemname >status</tree-itemname><tree-itemdesc > Статус объекта. Допустимые значения: 
- sync — синхронизирован;
- pending — отправляется.
</tree-itemdesc></tree-item></tree-item><tree-item id="links-self"><tree-itemname >links</tree-itemname><tree-itemdesc id="links"> Ссылки, связанные с объектом. </tree-itemdesc><tree-item ><tree-itemname >self</tree-itemname><tree-itemdesc id="self"> Ссылка на текущий объект. </tree-itemdesc></tree-item></tree-item></tree-item><tree-item id="pages"><tree-itemname >links</tree-itemname><tree-itemdesc id="links-pages"> Постраничные ссылки. </tree-itemdesc><tree-item ><tree-itemname >first</tree-itemname><tree-itemdesc > Ссылка на первую страницу. </tree-itemdesc></tree-item><tree-item ><tree-itemname >next</tree-itemname><tree-itemdesc > Ссылка на следующую страницу. </tree-itemdesc></tree-item><tree-item ><tree-itemname >prev</tree-itemname><tree-itemdesc > Ссылка на предыдущую страницу. </tree-itemdesc></tree-item><tree-item ><tree-itemname >self</tree-itemname><tree-itemdesc > Ссылка на текущую страницу. </tree-itemdesc></tree-item><tree-item ><tree-itemname >last</tree-itemname><tree-itemdesc > Ссылка на последнюю страницу. </tree-itemdesc></tree-item></tree-item><tree-item id="meta"><tree-itemname >meta</tree-itemname><tree-itemdesc > Объект содержит метаинформацию. </tree-itemdesc><tree-item ><tree-itemname >found_rows</tree-itemname><tree-itemdesc > Общее количество объектов. </tree-itemdesc></tree-item><tree-item ><tree-itemname >count</tree-itemname><tree-itemdesc > Количество объектов в ответе. </tree-itemdesc></tree-item><tree-item ><tree-itemname >fields</tree-itemname><tree-itemdesc > Массив запрошенных параметров. </tree-itemdesc></tree-item><tree-item id="filter"><tree-itemname >filters</tree-itemname><tree-itemdesc > Фильтры, которые можно применить к объектам указанного ресурса. Подробнее о фильтрах в разделе [Построение фильтров](../concepts/filters.md). </tree-itemdesc><tree-item ><tree-itemname >name</tree-itemname><tree-itemdesc > Название параметра. </tree-itemdesc></tree-item><tree-item ><tree-itemname >values</tree-itemname><tree-itemdesc > Допустимые значения параметра. Используются для построения фильтра. </tree-itemdesc><tree-item ><tree-itemname >label</tree-itemname><tree-itemdesc > Название параметра в интерфейсе. </tree-itemdesc></tree-item><tree-item ><tree-itemname >id</tree-itemname><tree-itemdesc id="values-id"> Идентификатор значения фильтра. </tree-itemdesc></tree-item></tree-item><tree-item ><tree-itemname >label</tree-itemname><tree-itemdesc > Название параметра в интерфейсе. </tree-itemdesc></tree-item><tree-item ><tree-itemname >type</tree-itemname><tree-itemdesc id="filter-type"> Тип параметра. Помогает определить какие операторы можно использовать для построения фильтра. </tree-itemdesc></tree-item></tree-item></tree-item></tree>
```
-->

## Пример для JSON {#example-JSON}

> Запрос:
> 
> ```
> curl -i -g -H "Accept: application/vnd.api+json" -H "Authorization: token 66..." -X GET "https://jsonapi.partner2.yandex.com/v1/context_on_site_rtb?filter=["multistate","=","deleted"]&fields[context_on_site_rtb]=brands,multistate,multistate_name,actions,editable_fields,geo,status&page[size]=2&page[number]=2"
> ```
> 
> Ответ:
> 
> ```json
> HTTP/1.1 200 OK
> Server: nginx/1.8.1
> Date: Sun, 18 Dec 2016 12:39:50 GMT
> Content-Type: application/vnd.api+json
> Content-Length: 3607
> Connection: keep-alive
> 
> {
>   "data": [
>     {
>       "relationships": {
>         "context_on_site_campaign": {
>           "links": {
>             "related": "https://jsonapi.partner2.yandex.com/v1/context_on_site_rtb/R-A-1166-1/context_on_site_campaign",
>             "self": "https://jsonapi.partner2.yandex.com/v1/context_on_site_rtb/R-A-1166-1/relationships/context_on_site_campaign"
>           }
>         },
>         "pages": {
>           "links": {
>             "related": "https://jsonapi.partner2.yandex.com/v1/context_on_site_rtb/R-A-1166-1/pages",
>             "self": "https://jsonapi.partner2.yandex.com/v1/context_on_site_rtb/R-A-1166-1/relationships/pages"
>           }
>         }
>       },
>       "id": "R-A-1166-1",
>       "type": "context_on_site_rtb",
>       "attributes": {
>         "actions": {},
>         "geo": null,
>         "status": "sync",
>         "multistate_name": "Заархивирован.",
>         "multistate": 9,
>         "editable_fields": {},
>         "brands": "[]"
>       },
>       "links": {
>         "self": "https://jsonapi.partner2.yandex.com/v1/context_on_site_rtb/R-A-1166-1"
>       }
>     },
>     {
>       "relationships": {
>         "context_on_site_campaign": {
>           "links": {
>             "related": "https://jsonapi.partner2.yandex.com/v1/context_on_site_rtb/R-A-1304-1/context_on_site_campaign",
>             "self": "https://jsonapi.partner2.yandex.com/v1/context_on_site_rtb/R-A-1304-1/relationships/context_on_site_campaign"
>           }
>         },
>         "pages": {
>           "links": {
>             "related": "https://jsonapi.partner2.yandex.com/v1/context_on_site_rtb/R-A-1304-1/pages",
>             "self": "https://jsonapi.partner2.yandex.com/v1/context_on_site_rtb/R-A-1304-1/relationships/pages"
>           }
>         }
>       },
>       "id": "R-A-1304-1",
>       "type": "context_on_site_rtb",
>       "attributes": {
>         "actions": {},
>         "geo": null,
>         "status": "sync",
>         "multistate_name": "Заархивирован.\nНет статистики.",
>         "multistate": 13,
>         "editable_fields": {},
>         "brands": "[]"
>       },
>       "links": {
>         "self": "https://jsonapi.partner2.yandex.com/v1/context_on_site_rtb/R-A-1304-1"
>       }
>     }
>   ],
>   "links": {
>     "first": "https://jsonapi.partner2.yandex.com/v1/context_on_site_rtb?apikey=66..&fields%5Bcontext_on_site_rtb%5D=brands,multistate,multistate_name,actions,editable_fields,geo,status&page%5Bsize%5D=2&filter=%7B%22multistate%22:%22deleted%22%7D&page%5Bnumber%5D=1",
>     "next": "https://jsonapi.partner2.yandex.com/v1/context_on_site_rtb?apikey=66..&fields%5Bcontext_on_site_rtb%5D=brands,multistate,multistate_name,actions,editable_fields,geo,status&page%5Bsize%5D=2&filter=%7B%22multistate%22:%22deleted%22%7D&page%5Bnumber%5D=3",
>     "prev": "https://jsonapi.partner2.yandex.com/v1/context_on_site_rtb?apikey=6..&fields%5Bcontext_on_site_rtb%5D=brands,multistate,multistate_name,actions,editable_fields,geo,status&page%5Bsize%5D=2&filter=%7B%22multistate%22:%22deleted%22%7D&page%5Bnumber%5D=1",
>     "self": "https://jsonapi.partner2.yandex.com/v1/context_on_site_rtb?apikey=66..&fields%5Bcontext_on_site_rtb%5D=brands,multistate,multistate_name,actions,editable_fields,geo,status&page%5Bsize%5D=2&page%5Bnumber%5D=2&filter=%7B%22multistate%22:%22deleted%22%7D",
>     "last": "https://jsonapi.partner2.yandex.com/v1/context_on_site_rtb?apikey=66..&fields%5Bcontext_on_site_rtb%5D=brands,multistate,multistate_name,actions,editable_fields,geo,status&page%5Bsize%5D=2&filter=%7B%22multistate%22:%22deleted%22%7D&page%5Bnumber%5D=2798"
>   },
>   "meta": {
>     "found_rows": 5595,
>     "count": 2,
>     "fields": [
>       "actions",
>       "brands",
>       "editable_fields",
>       "geo",
>       "multistate",
>       "multistate_name",
>       "status"
>     ],
>     "filters": 
>     [
>       {
>         "name": "multistate",
>         "values":
>         [
>           {
>             "label": "Нет статистики",
>             "id": "check_statistics"
>           },
>           {
>             "label": "Заархивирован",
>             "id": "deleted" 
>           },
>           {
>             "label": "Сохранение изменений",
>             "id": "need_update" 
>           },
>           {
>             "label": "Обновление",
>             "id": "updating" 
>           },
>           {
>             "label": "Работает",
>             "id": "working" 
>           }
>         ],
>         "label": "Статус",
>         "type": "multistate"
>       }
>     ]
>   }
> }
>             
> ```