---
metadata:
  - name: generator
    content: Diplodoc Platform v5.50.6
alternate:
  - https://yandex.ru/dev/direct/doc/en/retargetinglists/get.md
  - https://yandex.ru/dev/direct/doc/ru/retargetinglists/get.md
sourcePath: en/ref-v5/retargetinglists/get.md
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.ru/dev/direct/doc/en/llms.txt

# get

Returns retargeting lists.## Learn more

- [How the "get" method works](https://yandex.com/dev/direct/doc/best-practice/get.html)

## Restrictions {#restrictions}

The method returns a maximum of 10,000 objects.


## Request {#input}

Request structure in JSON format:

```javascript translate=no
{
  "method": "get",
  "params": { /* params */
    "SelectionCriteria": {  /* RetargetingListSelectionCriteria */
      "Ids": [(long), ... ],
      "Types": [( RETARGETING | AUDIENCE ), ... ]
    },
    "FieldNames": [( "Type" | "Id" | "Name" | "Description" | "Rules" | "IsAvailable" | "Scope" | "AvailableForTargetsInAdGroupTypes" ), ... ], /* required */
    "Page": {  /* LimitOffset */
      "Limit": (long),
      "Offset": (long)
    }
  }
}
```


#|
||
**Parameter**
|
**Type**
|
**Description**
|
**Required**
||

||
**params structure (for JSON) / GetRequest (for SOAP)**
||
||
`SelectionCriteria`
|
RetargetingListSelectionCriteria
|
Criteria for selecting retargeting lists. If omitted, all retargeting lists that belong to the user will be returned.
|
No
||
||
`FieldNames`
|
array of RetargetingListFieldEnum
|
Names of top-level parameters to get.
|
Yes
||
||
`Page`
|
[LimitOffset](https://yandex.com/dev/direct/doc/best-practice/get.html#LimitOffset)
|
Structure that defines the page for [paginated selection](https://yandex.com/dev/direct/doc/best-practice/get.html) of data.
|
No
||

||
**RetargetingListSelectionCriteria structure**
||
||
`Ids`
|
array of long
|
Selects the retargeting lists with the specified IDs. From 1 to 10,000 items in the array.
|
No
||
||
`Types`
|
array of RetargetingListTypeEnum
|
Selects the retargeting lists with the specified types. See the section [Type of retargeting lists](https://yandex.com/dev/direct/doc/objects/retargeting-list.html).
|
No
||
|# 


## Response {#output}

Response structure in JSON format:

```javascript translate=no
{
  "result": { /* result */
    "RetargetingLists": [{  /* RetargetingListGetItem */
      "Type": ( RETARGETING | AUDIENCE ),
      "Id": (long),
      "IsAvailable": ( "YES" | "NO" ),
      "Name": (string),
      "Description": (string),
      "Rules": [{ /* RetargetingListRuleItem */
        "Arguments": [{  /* RetargetingListRuleArgumentItem */
          "MembershipLifeSpan": (int), /* required */
          "ExternalId": (long) /* required */
        }, ... ], /* required */
        "Operator": ( "ALL" | "ANY" | "NONE" ) /* required */
      }, ... ],
      "Scope": ( "FOR_TARGETS_AND_ADJUSTMENTS" | "FOR_ADJUSTMENTS_ONLY" | "FOR_TARGETS_ONLY" ),
      "AvailableForTargetsInAdGroupTypes": { /* AvailableForTargetsInAdGroupTypesArray */
        "Items": [( "TEXT_AD_GROUP" | "MOBILE_APP_AD_GROUP" | "DYNAMIC_TEXT_AD_GROUP"
                    | "CPM_BANNER_AD_GROUP" | "CPM_VIDEO_AD_GROUP" | "CONTENT_PROMOTION_AD_GROUP"
                    | "SMART_AD_GROUP" ), ... ]
      } /* nillable */
    }, ... ],
    "LimitedBy": (long)
  }
}
```


#|
||
**Parameter**
|
**Type**
|
**Description**
||

||
**result structure (for JSON) / GetResponse (for SOAP)**
||
||
`RetargetingLists`
|
array of RetargetingListGetItem
|
Retargeting lists.
||
||
`LimitedBy`
|
long
|
Sequential number of the last object returned. It is included if there was a limit on the number of objects in the response. See the section [Paginated data selection](https://yandex.com/dev/direct/doc/best-practice/get.html).
||

||
**RetargetingListGetItem structure**
||
||
`Type`
|
RetargetingListTypeEnum
|
Type of retargeting list. See the section [Type of retargeting lists](https://yandex.com/dev/direct/doc/objects/retargeting-list.html).
||
||
`Id`
|
long
|
ID of the retargeting list.
||
||
`Name`
|
string
|
Name of the retargeting list (maximum of 250 characters).
||
||
`Description`
|
string
|
Text note for the retargeting list (maximum of 4096 characters).
||
||
`IsAvailable`
|
YesNoEnum
|
YES — All the goals and segments in the retargeting list are available; NO —  The retargeting list has a goal or segment that is unavailable, so ad displays and bid adjustments aren't possible for this retargeting list.

A goal or segment becomes unavailable if it is deleted or the owner revokes access (see [Managing tag access](https://yandex.ru/support/metrika/general/access.html)[Managing tag access](https://yandex.com/support/metrica/general/access.html) in Yandex Metrica Help).
||
||
`Rules`
|
array of RetargetingListRuleItem
|
Rules for selecting site users. In order for the retargeting list to apply, the user must meet all the rules at once.
For restrictions on user selection rules and examples of the structure, see the section [Rules for user selection](https://yandex.com/dev/direct/doc/objects/retargeting-list.html).
||
||
`Scope`
|
RetargetingListScopeEnum
|
The scope of the retargeting list: audience targeting, bid adjustments, or everywhere. See the section [Scope](https://yandex.com/dev/direct/doc/objects/retargeting-list.html).
||
||
`AvailableForTargetsInAdGroupTypes`
|
AvailableForTargetsInAdGroupTypesArray
|
The scope of the retargeting list: types of groups to which you can add an audience target for this retargeting list.
null (nil): You can use the retargeting list only in bid adjustments.
||

||
**RetargetingListRuleItem structure**
||
||
`Arguments`
|
array of RetargetingListRuleArgumentItem
|
Goals and segments.

See the section [Goals and segments](https://yandex.com/dev/direct/doc/objects/retargeting-list.html).
||
||
`Operator`
|
RetargetingListRuleOperatorEnum
|
Logical operator for the retargeting list:

- ALL — the rule is met if the user completed all the goals and is included in all the segments.

- ANY — The rule is met if the user completed at least one of the goals or the user's session is included in at least one of the segments.

- NONE — The rule is met if the user didn't complete any of the goals and the user's session isn't included in any of the segments.
||

||
**RetargetingListRuleArgumentItem structure**
||
||
`MembershipLifeSpan`
|
int
|
The number of days (from 1 to 540) for checking for a goal conversion.

This parameter is not used with Yandex Metrica and Yandex Audience segments.
||
||
`ExternalId`
|
long
|
ID of the goal or segment.

For segments by [user interests](https://yandex.com/support/direct/en/products-cpm-campaign/display-ads-settings.html#display-ads-settings__user-interests), use identifier prefixes to specify interest types:

- 10 — A short-term interest.
- 20 — A long-term interest.
- 30 — Any interest.

For example, the segment ID `2499001105` with a long-term interest will become `ExternalId``202499001105`.
||

||
**AvailableForTargetsInAdGroupTypesArray structure**
||
||
`Items`
|
array of AdGroupTypesEnum
|
Types of groups to which you can add an audience target for this retargeting list.
||
|#