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


# GET/resources 

Возвращает список доступных ресурсов.

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

```
GET https://jsonapi.partner2.yandex.com/vX/resources
  ? [fields[resources]=<string>]
```

### Параметры

#|
|| **Параметр** | **Описание** ||
|| `fields[resources]`
| Вывод параметров, доступных для массива ресурсов. Допустимые значения:

- `available_fields` — массив параметров, доступных для ресурса;

- `title` — вывод названия ресурса;

- `available_actions` — массив действий, доступных для ресурса;

- `methods` — массив методов, доступных для ресурса.

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

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


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

## JSON

```json
{
  "data": [
    {
      "type": "{string}",
      "id": "{string}",
      "attributes": {
        "available_actions": [
          "{string}",
          "{string}"
        ],
        "methods": [
          "{string}",
          "{string}"
        ],
        "available_fields": [
          "actions",
          "brands",
          "client_id",
          "email",
          "excluded_domains",
          "excluded_phones",
          "geo",
          "lang",
          "lastname",
          "level",
          "login",
          "midname",
          "multistate",
          "multistate_name"
          "name",
          "page_id",
          "parent_id",
          "regularity",
          "roles",
          "status",
          ...
        ],
        "title": "{string}"
      },
      "meta": {
        "show_in_menu": {boolean}
      },
      "links": {
        "self": "{string}"
      }
    },
    ...
  ],
  "links": {
    "self": "{string}"
  },
  "meta": {
    "count": {integer},
    "fields": [
      "{string}",
      "{string}"
    ]
  }
}
```

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

- **data** Массив с доступными ресурсами.

  - **type** Тип данных (в данном случае ресурс).

  - **id** Идентификатор ресурса.

  - **attributes** Объект содержит параметры, доступные для ресурса.

    - **available_actions** Массив действий, доступных для ресурса.

    - **methods** Массив методов, доступных для ресурса. Используется в интерфейсе.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

      - **status** Статус объекта.

    - **title** Название ресурса.

  - **meta** Объект содержит служебные параметры.

    - **show_in_menu** Признак наличия ресурса в меню в интерфейсе.

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

    - **self** Ссылка на ресурс.

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

  - **self** Ссылка на запрос.

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

  - **count** Общее количество ресурсов.

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


<!--
```
<tree ><tree-item ><tree-itemname >data</tree-itemname><tree-itemdesc > Массив с доступными ресурсами. </tree-itemdesc><tree-item ><tree-itemname >type</tree-itemname><tree-itemdesc > Тип данных (в данном случае ресурс). </tree-itemdesc></tree-item><tree-item ><tree-itemname >id</tree-itemname><tree-itemdesc > Идентификатор ресурса. </tree-itemdesc></tree-item><tree-item ><tree-itemname >attributes</tree-itemname><tree-itemdesc > Объект содержит параметры, доступные для ресурса. </tree-itemdesc><tree-item ><tree-itemname >available_actions</tree-itemname><tree-itemdesc > Массив действий, доступных для ресурса. </tree-itemdesc></tree-item><tree-item ><tree-itemname >methods</tree-itemname><tree-itemdesc > Массив методов, доступных для ресурса. Используется в интерфейсе. </tree-itemdesc></tree-item><tree-item ><tree-itemname >available_fields</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-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-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 > Статус объекта. </tree-itemdesc></tree-item></tree-item><tree-item ><tree-itemname >title</tree-itemname><tree-itemdesc > Название ресурса. </tree-itemdesc></tree-item></tree-item><tree-item ><tree-itemname >meta</tree-itemname><tree-itemdesc > Объект содержит служебные параметры. </tree-itemdesc><tree-item ><tree-itemname >show_in_menu</tree-itemname><tree-itemdesc > Признак наличия ресурса в меню в интерфейсе. </tree-itemdesc></tree-item></tree-item><tree-item ><tree-itemname >links</tree-itemname><tree-itemdesc > Ссылки, связанные с ресурсом. </tree-itemdesc><tree-item ><tree-itemname >self</tree-itemname><tree-itemdesc > Ссылка на ресурс. </tree-itemdesc></tree-item></tree-item></tree-item><tree-item ><tree-itemname >links</tree-itemname><tree-itemdesc id="links"> Ссылки, связанные с ресурсом. </tree-itemdesc><tree-item ><tree-itemname >self</tree-itemname><tree-itemdesc id="links-self"> Ссылка на запрос. </tree-itemdesc></tree-item></tree-item><tree-item ><tree-itemname >meta</tree-itemname><tree-itemdesc id="meta-inf"> Объект содержит метаинформацию. </tree-itemdesc><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></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/resources?fields[resources]=available_fields,title,available_actions,methods'
> 
> ```
> 
> Ответ:
> 
> ```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: 3761
> Connection: keep-alive
> 
> {
>   "data": [
>     {
>       "type": "resources",
>       "id": "resources",
>       "attributes": {
>         "available_actions": [],
>         "methods": [
>           "GET"
>         ],
>         "available_fields": [
>           "title",
>           "available_fields",
>           "available_actions",
>           "methods"
>         ],
>         "title": "Ресурсы"
>       },
>       "meta": {
>         "show_in_menu": false
>       },
>       "links": {
>         "self": "https://jsonapi.partner2...v1/resources/resources"
>       }
>     },
>     {
>       "type": "resources",
>       "id": "context_on_site_rtb",
>       "attributes": {
>         "available_actions": [
>           "duplicate"
>         ],
>         "methods": [
>           "GET",
>           "POST"
>         ],
>         "available_fields": [
>           "brands",
>           "multistate",
>           "multistate_name",
>           "actions",
>           "editable_fields",
>           "geo",
>           "status"
>         ],
>         "title": "RTB-блоки"
>       },
>       "meta": {
>         "show_in_menu": true
>       },
>       "links": {
>         "self": "https://jsonapi.partner2...v1/resources/context_on_site_rtb"
>       }
>     },
>     ...
>     {
>       "type": "resources",
>       "id": "search_on_site_campaign",
>       "attributes": {
>         "available_actions": [],
>         "methods": [
>           "GET",
>           "POST"
>         ],
>         "available_fields": [
>           "excluded_domains",
>           "excluded_phones",
>           "multistate",
>           "multistate_name",
>           "editable_fields",
>           "status"
>         ],
>         "title": "Поисковые площадки"
>       },
>       "meta": {
>         "show_in_menu": true
>       },
>       "links": {
>         "self": "https://jsonapi.partner2...v1/resources/search_on_site_campaign"
>       }
>     },
>     {
>       "type": "resources",
>       "id": "context_on_site_campaign",
>       "attributes": {
>         "available_actions": [],
>         "methods": [
>           "GET",
>           "POST"
>         ],
>         "available_fields": [
>           "page_id",
>           "excluded_domains",
>           "excluded_phones",
>           "multistate",
>           "multistate_name",
>           "editable_fields",
>           "status"
>         ],
>         "title": "Тематические площадки"
>       },
>       "meta": {
>         "show_in_menu": true
>       },
>       "links": {
>         "self": "https://jsonapi.partner2...v1/resources/context_on_site_campaign"
>       }
>     }
>   ],
>   "links": {
>   "self": "https://jsonapi.partner2...v1/resources?fields%5Bresources%5D=available_fields,title,available_actions,methods..."
>   },
>   "meta": {
>     "count": 13,
>     "fields": [
>       "available_fields",
>       "title",
>       "available_actions",
>       "methods"
>     ]
>   }
> }
> ```