---
metadata:
  - name: generator
    content: Diplodoc Platform v5.52.0
alternate:
  - https://yandex.ru/dev/direct/doc/en/sitelinks/get.md
  - https://yandex.ru/dev/direct/doc/ru/sitelinks/get.md
  - href: en/sitelinks/get.md
    type: text/markdown
    title: Markdown version
  - href: ../llms.txt
    type: text/markdown
    title: llms.txt
sourcePath: en/ref-v5/sitelinks/get.md
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.ru/dev/direct/doc/en/llms.txt

# get

Returns sets of sitelinks that match the specified criteria.

## 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": {  /* IdsCriteria */
      "Ids": [(long), ... ] /* required */
    },
    "FieldNames": [( "Id" | "Sitelinks" ), ... ],
    "SitelinkFieldNames": [( "Title" | "Href" | "Description" | "TurboPageId" ), ... ],
    "Page": {  /* LimitOffset */
      "Limit": (long),
      "Offset": (long)
    }
  }
}
```


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

||
**params structure (for JSON) / GetRequest (for SOAP)**
||
||
`SelectionCriteria`
|
IdsCriteria
|
Criteria for selecting sets. If omitted, all of the user's sets will be returned.
|
No
||
||
`FieldNames`
|
array of SitelinksSetFieldEnum
|
Names of top-level parameters to get.

If the `Sitelinks` value is specified, then the `Sitelinks` array returns the following sitelink fields: `Title`, `Href`, and `Description`.

If you need to get a different set of fields, list their names in the `SitelinkFieldNames` parameter and omit the `Sitelinks` value in the `FieldNames` parameter.
|
No
||
||
`SitelinkFieldNames`
|
array of SitelinkFieldEnum
|
Names of sitelink fields to get.
|
No
||
||
`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
||

||
**IdsCriteria structure**
||
||
`Ids`
|
array of long
|
IDs of sets to get.
|
Yes
||
|# 


## Response {#output}

Response structure in JSON format:

```javascript translate=no
{
  "result": { /* result */
    "SitelinksSets": [{  /* SitelinksSetGetItem */
      "Id": (long),
      "Sitelinks": [{  /* Sitelink */
        "Title": (string),
        "Href": (string), /* nillable */
        "Description": (string), /* nillable */
        "TurboPageId": (long) /* nillable */
      }, ... ]
    }, ... ],
    "LimitedBy": (long)
  }
}
```


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

||
**result structure (for JSON) / GetResponse (for SOAP)**
||
||
`SitelinksSets`
|
array of SitelinksSetGetItem
|
Sets of sitelinks.
||
||
`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).
||

||
**SitelinksSetGetItem structure**
||
||
`Id`
|
long
|
ID of a set of sitelinks.
||
||
`Sitelinks`
|
Sitelink
|
Array of 1 to 4 Sitelink objects.
||

||
**Sitelink structure**
||
||
`Title`
|
string
|
Sitelink text.
||
||
`Href`
|
string, nillable
|
Sitelink address.
||
||
`Description`
|
string, nillable
|
Sitelink description for displaying the ad in expanded format.
||
||
`TurboPageId`
|
long, nillable
|
ID of the Turbo page.
||
|#