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


# GET/{resource-id}/{object-id}

Returns the specified object.

## Request format {#input}

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

#|
|| **Parameter** | **Description** ||
|| `resource-id`
| ID of the resource to get information for.
||
|| `object-id`
| ID of the returned object.
||
|| `fields[{resource-id}]`
|

<!-- source: en/_includes/fields-resource-id.md -->
Parameters that are available for objects. Acceptable values:

- `actions` — Actions allowed for the current object.

- `block_type` — Ad unit type.

- `brands` — Brands set for this object.

- `client_id` — Client ID.

- `dsp_blocks` — Size of display ad unit. For interstitial and rewarded units, you can leave this field empty.

- `editable_fields` — Parameters of the current object that can be edited.

- `email` — The client's email address.

- `excluded_domains` — Excluded domains.

- `excluded_phones` — Excluded phones.

- `formats_setup_mode` — Format settings. Acceptable values:

    - standard — Unit formats are configured automatically using default parameters.

    - manual — Unit formats are configured in the `design_templates` parameter.
    
- `geo` — Regional targeting set for this object.

- `lang` — Interface language.

- `lastname` — The client's last name.

- `level` — The nesting level.

- `login` — User login.

- `midname` — The user's middle name.

- `multistate` — The current status of the object.

- `multistate_name` — Text description of the object's status.

- `name` — Name of the object.

- `page_id` — Site ID.

- `parent_id` — ID of the parent object.

- `regularity` — Sorting order in the interface.

- `roles` — The user's roles.

- `status` — Status of the object. Acceptable values:

    - sync — Synchronized.

    - pending — Sending.
    
- `tech_type` — Field for working with units for Turbo and AMP pages. Only applicable for `"block_type" : "banner"`. Acceptable values:

    - turbo — Turbo unit.
    
    - amp — AMP unit.
    

{% note alert "Restriction." %}

The allowed values depend on the resource. They are listed in the `available_fields` parameter for the [GET/resources](https://yandex.ru/dev/partner-objects/doc/en/reference/get-resources.md) operation.

{% endnote %}

To add multiple values to the request, separate them with commas.
<!-- endsource: en/_includes/fields-resource-id.md -->

||
|| `include`
| 

<!-- source: en/_includes/include-resource-id.md -->
ID of the related resource. The response contains additional information about the related resource.

{% note info %}

To add multiple resources to the request, separate them with commas.

{% endnote %}
<!-- endsource: en/_includes/include-resource-id.md -->

||
|#

The general structure of the response is given below. The elements may appear in a different order. The structure may contain internal parameters that are not described in the table.


## Response format {#output-structure}

## JSON

```json
{
  "included":
  [
    {
      "relationships": {
        "{string}": {
          "links": {
            "related": "{string}",
            "self": "{string}"
          }
        },
        ...
      },
      "id": "{string}",
      "type": "{string}",
      "attributes": {
        "actions": {...},
        "brands": [
          {
            "bid": "{string}",
            "blocked": {boolean},
            "cpm": {integer}
          },
          {
            ...
          }
        ],
        "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": {
      "actions": {...},
      "brands": [
        {
          "bid": "{string}",
          "blocked": {boolean},
          "cpm": {integer}
        },
        {
          ...
        }
      ],
      "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}"
  },
  "meta": {
    "fields": [
      "{string}",
      "{string}"
    ]
  }
}    
```

## Response parameters {#spec-output}

- **included** Array of objects of the specified related resource.

  - **relationships** Related resources and objects.

    - **links** References to objects related to the current object.

      - **related** Reference to a list of related objects with parameters.

      - **self** Reference to a list of related objects.

  - **id** Object ID.

  - **type** Resource type.

  - **attributes** Array of object parameters. The list of parameters depends on the resource type. As an example, some of the parameters are shown below.

    - **actions** Actions allowed for the current object.

    - **brands** Brands set for this object.

      - **bid** The minimum bid required for showing the brand (in rubles).

      - **blocked** The brand is blocked (`true` or `false`).

    - **client_id** Client ID.

    - **editable_fields** Parameters of the current object that can be edited.

    - **email** The client's email address.

    - **excluded_domains** Excluded domains.

    - **excluded_phones** Excluded phones.

    - **geo** Regional targeting set for this object.

      - **id** Region ID. Use the [GET/{resource-id}](https://yandex.ru/dev/partner-objects/doc/en/reference/get-resource-id.md) operation to get the region.

      - **cpm** The minimum CPM required for showing the brand in the current region (in rubles).

    - **lang** Interface language.

    - **lastname** The client's last name.

    - **level** The nesting level.

    - **login** User login.

    - **midname** The user's middle name.

    - **multistate** The current status of the object.

    - **multistate_name** Text description of the object's status.

    - **name** Object name.

    - **page_id** Site ID.

    - **parent_id** ID of the parent object.

    - **regularity** Sorting order in the interface.

    - **roles** The user's roles.

    - **status** Object status. Acceptable values:

                 - **sync** — Synchronized.

                 - **pending** — Sending.

  - **links** Links associated with the object.

    - **self** Reference to the current object.

- **data** Array of objects of the specified resource.

  - **relationships** Related resources and objects.

    - **links** References to objects related to the current object.

      - **related** Reference to a list of related objects with parameters.

      - **self** Reference to a list of related objects.

  - **id** Object ID.

  - **type** Resource type.

  - **attributes** Array of object parameters. The list of parameters depends on the resource type. As an example, some of the parameters are shown below.

    - **actions** Actions allowed for the current object.

    - **brands** Brands set for this object.

      - **bid** The minimum bid required for showing the brand (in rubles).

      - **blocked** The brand is blocked (true or false).

    - **client_id** Client ID.

    - **editable_fields** Parameters of the current object that can be edited.

    - **email** The client's email address.

    - **excluded_domains** Excluded domains.

    - **excluded_phones** Excluded phones.

    - **geo** Regional targeting set for this object.

      - **id** Region ID. Use the [GET/{resource-id}](https://yandex.ru/dev/partner-objects/doc/en/reference/get-resource-id.md) operation to get the region.

      - **cpm** The minimum CPM required for showing the brand in the current region (in rubles).

    - **lang** Interface language.

    - **lastname** The client's last name.

    - **level** The nesting level.

    - **login** User login.

    - **midname** The user's middle name.

    - **multistate** The current status of the object.

    - **multistate_name** Text description of the object's status.

    - **name** Object name.

    - **page_id** Site ID.

    - **parent_id** ID of the parent object.

    - **regularity** Sorting order in the interface.

    - **roles** The user's roles.

    - **status** Object status. Acceptable values:

                 - **sync** — Synchronized.

                 - **pending** — Sending.

- **links** Links associated with the object.

  - **self** Reference to the current object.

- **meta** This object contains meta information.

  - **fields** The array of requested parameters.


<!--
```
<tree id="object-info"><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-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 ><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 ><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><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-itemname >meta</tree-itemname><tree-itemdesc > Объект содержит метаинформацию. </tree-itemdesc><tree-item ><tree-itemname >fields</tree-itemname><tree-itemdesc > Массив запрошенных параметров. </tree-itemdesc></tree-item></tree-item></tree>
```
-->

## Example for JSON {#example-JSON}

> Request:
> 
> ```
> curl -i -g -H "Accept: application/vnd.api+json" -H "Authorization: token bf..." -X GET "https://jsonapi.partner2.yandex.com/v1/context_on_site_rtb/R-A-3228-1?fields[context_on_site_rtb]=brands,multistate,multistate_name,actions,editable_fields,geo,status"
> ```
> 
> Response:
> 
> ```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: 1099
> Connection: keep-alive{
>   "data":{
>     "relationships":{
>       "context_on_site_campaign":{
>         "links":{
>           "related": "https://jsonapi.partner2.yandex.com/v1/context_on_site_rtb/R-A-3228-1/context_on_site_campaign",
>           "self": "https://jsonapi.partner2.yandex.com/v1/context_on_site_rtb/R-A-3228-1/relationships/context_on_site_campaign"
>         }
>       },
>       "pages":{
>         "links":{
>           "related": "https://jsonapi.partner2.yandex.com/v1/context_on_site_rtb/R-A-3228-1/pages",
>           "self": "https://jsonapi.partner2.yandex.com/v1/context_on_site_rtb/R-A-3228-1/relationships/pages"
>         }
>       }
>     },
>     "id": "R-A-3228-1",
>     "type": "context_on_site_rtb",
>     "attributes":{
>       "actions":{
>         "duplicate": "Duplicate"
>       },
>       "geo": null,
>       "status": "sync",
>       "multistate_name": "Active.",
>       "multistate": 2,
>       "editable_fields":{
>         "geo": true,
>         "brands": true
>       },
>       "brands": "[{"bid":"5414","blocked":true},{"bid":"827490","blocked":true}]"
>     }
>   },
>   "links":{
>     "self": "https://jsonapi.partner2.yandex.com/v1/context_on_site_rtb/R-A-3228-1"
>   },
>   "meta":{
>     "fields": [
>       "actions",
>       "brands",
>       "editable_fields",
>       "geo",
>       "multistate",
>       "multistate_name",
>       "status"
>     ]
>   }
> }    
> ```