---
metadata:
  - name: generator
    content: Diplodoc Platform v5.70.0
alternate:
  - https://yandex.ru/support/wiki/en/api-ref/pagesresources/pagesresources__resources.md
  - https://yandex.ru/support/wiki/ru/api-ref/pagesresources/pagesresources__resources.md
  - href: https://yandex.ru/support/wiki/en/api-ref/pagesresources/pagesresources__resources.md
    type: text/markdown
    title: Markdown version
  - href: https://yandex.ru/support/wiki/en/llms.txt?revision=r22094953
    rel: describedby
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.ru/support/wiki/en/llms.txt?revision=r22094953

<div class="openapi">

# Resources

<!-- markdownlint-disable-file -->

Returns page resources in the `results` array. Each element contains the resource type in `type` and resource data in `item`:

* `attachment`: an attached file, including its ID, name, download URL, size in MiB, description, uploader, upload time, MIME type, download and preview availability, and antivirus scan status.
* `grid`: a dynamic table, including its ID, title, and creation time.

Example response for a page with a file and a dynamic table:

```json
{
  "results": [
    {
      "type": "attachment",
      "item": {
        "id": 12345,
        "name": "report.pdf",
        "is_downloadable": true,
        "download_url": "/team/project/.files/report.pdf",
        "size": "1.00",
        "description": "",
        "user": null,
        "created_at": "2026-11-02T09:00:00Z",
        "mimetype": "application/pdf",
        "has_preview": true,
        "check_status": "ready"
      }
    },
    {
      "type": "grid",
      "item": {
        "id": "123e4567-e89b-42d3-a456-426614174000",
        "title": "Tasks",
        "created_at": "2026-11-02T08:00:00Z"
      }
    }
  ],
  "next_cursor": null,
  "prev_cursor": null
}
```

For common headers and authentication methods, see [Access to the API](https://yandex.ru/support/wiki/en/api-ref/access.md#headers). For sample scenarios, see [API usage examples](https://yandex.ru/support/wiki/en/api-ref/examples.md).

## Request

<div class="openapi__requests">

<div class="openapi__request__wrapper" style="--method: var(--dc-openapi-methods-get);margin-bottom: 12px">

<div class="openapi__request">

GET {.openapi__method}
```text translate=no
https://api.wiki.yandex.net/v1/pages/{idx}/resources
```

</div>

</div>

</div>

### Path parameters

#|
|| **Name** | **Description** ||
||

_idx_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: integer

Page ID. The value of `idx` is the same as the `id` field value in the response to `GET /v1/pages?slug=…` or `POST /v1/pages`.
{.table-cell}
||
|#{.json-schema-properties}

### Query parameters

#|
|| **Name** | **Description** ||
||

_cursor_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

A pagination cursor from `next_cursor` or `prev_cursor` in the previous response

_Example:_{.json-schema-reset .json-schema-example} ``
{.table-cell}
||
||

_order_by_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

If specified, sort results by this field in the direction given by `order_direction`

_Enum:_{.json-schema-reset .json-schema-value} `name_title`, `created_at`
{.table-cell}
||
||

_order_direction_{.json-schema-reset .json-schema-property}
{.table-cell}|
{% cut "**All of**: OrderDirection" %}{.json-schema-combinators data-marker=and}

- **OrderDirection**

  **Type**: string

  An enumeration.

  _Enum:_{.json-schema-reset .json-schema-value} `asc`, `desc`

{% endcut %}

Sort direction, if the `order_by` field is specified

_Default:_{.json-schema-reset .json-schema-value} `asc`

_Example:_{.json-schema-reset .json-schema-example} ``
{.table-cell}
||
||

_page_size_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: integer

Number of results per page.

_Default:_{.json-schema-reset .json-schema-value} `50`

_Min value:_{.json-schema-reset .json-schema-assertion} `1`

_Max value:_{.json-schema-reset .json-schema-assertion} `100`
{.table-cell}
||
||

_q_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

Search by title

_Max length:_{.json-schema-reset .json-schema-assertion} `255`

_Example:_{.json-schema-reset .json-schema-example} ``
{.table-cell}
||
||

_types_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

Required resource types, comma-separated. Possible values: attachment, grid

_Example:_{.json-schema-reset .json-schema-example} ``
{.table-cell}
||
|#{.json-schema-properties}

## Responses

<div class="openapi__response__code__200">

## 200 OK

OK

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
{
  "results": [
    {
      "type": "attachment",
      "item": {
        "id": 0,
        "name": "example",
        "is_downloadable": true,
        "download_url": "example",
        "size": "example",
        "description": "example",
        "user": null,
        "created_at": "2025-01-01T00:00:00Z",
        "mimetype": "example",
        "has_preview": true,
        "check_status": "ready"
      }
    }
  ],
  "next_cursor": "example",
  "prev_cursor": "example"
}
```

{% endcut %}

#|
|| **Name** | **Description** ||
||

_results_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: [Resource](#entity-Resource)[]

Items on the current page of results

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  {
    "type": "attachment",
    "item": {
      "id": 0,
      "name": "example",
      "is_downloadable": true,
      "download_url": "example",
      "size": "example",
      "description": "example",
      "user": null,
      "created_at": "2025-01-01T00:00:00Z",
      "mimetype": "example",
      "has_preview": true,
      "check_status": "ready"
    }
  }
]
```

{% endcut %}
{.table-cell}
||
||

_next_cursor_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

A cursor for requesting the next page of results

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_prev_cursor_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

Cursor for requesting the previous page of results

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
|#{.json-schema-properties}

</div>

<div class="openapi-entity">

### ResourceType {#entity-ResourceType}

Page resource type:
- `attachment`: An attached file.
- `grid`: A dynamic table.

**Type**: string

_Enum:_{.json-schema-reset .json-schema-value} `attachment`, `grid`

</div>

<div class="openapi-entity">

### UserIdentity {#entity-UserIdentity}

User identifier

#|
|| **Name** | **Description** ||
||

_cloud_uid_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

User identifier in the cloud

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_uid_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

Yandex user ID

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "uid": "example",
  "cloud_uid": "example"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### UserSchema {#entity-UserSchema}

User information

#|
|| **Name** | **Description** ||
||

_affiliation_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

User affiliation

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_display_name_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

User display name

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_id_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: integer

Internal user identifier
{.table-cell}
||
||

_is_dismissed_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: boolean

The user is dismissed
{.table-cell}
||
||

_username_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

User login

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_identity_{.json-schema-reset .json-schema-property}
{.table-cell}|
{% cut "**All of 1 type**" %}{.json-schema-combinators data-marker=and}

- **UserIdentity**

  **Type**: [UserIdentity](#entity-UserIdentity)

  User identifier

  {% cut "**Example**" %}{.json-schema-example}

  ```json translate=no
  {
    "uid": "example",
    "cloud_uid": "example"
  }
  ```

  {% endcut %}

{% endcut %}

User identifier in the system

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "uid": "example",
  "cloud_uid": "example"
}
```

{% endcut %}
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "id": 0,
  "identity": {
    "uid": "example",
    "cloud_uid": "example"
  },
  "username": "example",
  "display_name": "example",
  "is_dismissed": true,
  "affiliation": "example"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### FileCheckStatusType {#entity-FileCheckStatusType}

File antivirus scan status:
- `check`: The file is being scanned.
- `ready`: The file is ready to use.
- `deleted`: The file has been deleted.
- `infected`: A virus was detected.
- `error`: An error occurred during the scan.

**Type**: string

_Enum:_{.json-schema-reset .json-schema-value} `check`, `ready`, `deleted`, `infected`, `error`

</div>

<div class="openapi-entity">

### AttachmentSchema {#entity-AttachmentSchema}

File attached to a page

#|
|| **Name** | **Description** ||
||

_created_at_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string&lt;date-time&gt;

Date and time the file was uploaded

_Example:_{.json-schema-reset .json-schema-example} `2025-01-01T00:00:00Z`
{.table-cell}
||
||

_description_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

File description

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_download_url_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

URL for downloading the file

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_has_preview_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: boolean

A preview is available for the file
{.table-cell}
||
||

_id_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: integer

Unique file ID
{.table-cell}
||
||

_mimetype_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

File MIME type

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_name_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

File name

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_size_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

File size in mebibytes (MiB)

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_check_status_{.json-schema-reset .json-schema-property}
{.table-cell}|
{% cut "**All of 1 type**" %}{.json-schema-combinators data-marker=and}

- **FileCheckStatusType**

  **Type**: [FileCheckStatusType](#entity-FileCheckStatusType)

  File antivirus scan status:
  - `check`: The file is being scanned.
  - `ready`: The file is ready to use.
  - `deleted`: The file has been deleted.
  - `infected`: A virus was detected.
  - `error`: An error occurred during the scan.

  _Enum:_{.json-schema-reset .json-schema-value} `check`, `ready`, `deleted`, `infected`, `error`

{% endcut %}

File antivirus check status

_Default:_{.json-schema-reset .json-schema-value} `ready`
{.table-cell}
||
||

_is_downloadable_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: boolean

The file is available for download

_Default:_{.json-schema-reset .json-schema-value} `true`
{.table-cell}
||
||

_user_{.json-schema-reset .json-schema-property}
{.table-cell}|
{% cut "**All of 1 type**" %}{.json-schema-combinators data-marker=and}

- **UserSchema**

  **Type**: [UserSchema](#entity-UserSchema)

  User information

  {% cut "**Example**" %}{.json-schema-example}

  ```json translate=no
  {
    "id": 0,
    "identity": {
      "uid": "example",
      "cloud_uid": "example"
    },
    "username": "example",
    "display_name": "example",
    "is_dismissed": true,
    "affiliation": "example"
  }
  ```

  {% endcut %}

{% endcut %}

User who uploaded the file

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "id": 0,
  "identity": {
    "uid": "example",
    "cloud_uid": "example"
  },
  "username": "example",
  "display_name": "example",
  "is_dismissed": true,
  "affiliation": "example"
}
```

{% endcut %}
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "id": 0,
  "name": "example",
  "is_downloadable": true,
  "download_url": "example",
  "size": "example",
  "description": "example",
  "user": {
    "id": 0,
    "identity": {
      "uid": "example",
      "cloud_uid": "example"
    },
    "username": "example",
    "display_name": "example",
    "is_dismissed": true,
    "affiliation": "example"
  },
  "created_at": "2025-01-01T00:00:00Z",
  "mimetype": "example",
  "has_preview": true,
  "check_status": "ready"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### PageGridsSchema {#entity-PageGridsSchema}

Brief information about a dynamic table on the page.

#|
|| **Name** | **Description** ||
||

_created_at_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string&lt;date-time&gt;

Date and time when the table was created.

_Example:_{.json-schema-reset .json-schema-example} `2025-01-01T00:00:00Z`
{.table-cell}
||
||

_id_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string&lt;uuid4&gt;

Dynamic table UUID. In `/v1/grids/{idx}` methods, the value of `idx` is the UUID from this field.

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_title_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

Table title.

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "id": "example",
  "title": "example",
  "created_at": "2025-01-01T00:00:00Z"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### Resource {#entity-Resource}

#|
|| **Name** | **Description** ||
||

_item_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
{% cut "**Any of 2 types**" %}{.json-schema-combinators data-marker=or}

- **AttachmentSchema**

  **Type**: [AttachmentSchema](#entity-AttachmentSchema)

  File attached to a page

  {% cut "**Example**" %}{.json-schema-example}

  ```json translate=no
  {
    "id": 0,
    "name": "example",
    "is_downloadable": true,
    "download_url": "example",
    "size": "example",
    "description": "example",
    "user": {
      "id": 0,
      "identity": {
        "uid": "example",
        "cloud_uid": "example"
      },
      "username": "example",
      "display_name": "example",
      "is_dismissed": true,
      "affiliation": "example"
    },
    "created_at": "2025-01-01T00:00:00Z",
    "mimetype": "example",
    "has_preview": true,
    "check_status": "ready"
  }
  ```

  {% endcut %}

- **PageGridsSchema**

  **Type**: [PageGridsSchema](#entity-PageGridsSchema)

  Brief information about a dynamic table on the page.

  {% cut "**Example**" %}{.json-schema-example}

  ```json translate=no
  {
    "id": "example",
    "title": "example",
    "created_at": "2025-01-01T00:00:00Z"
  }
  ```

  {% endcut %}

{% endcut %}

Resource details. A file when `type=attachment`, or a dynamic table when `type=grid`.

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "id": 0,
  "name": "example",
  "is_downloadable": true,
  "download_url": "example",
  "size": "example",
  "description": "example",
  "user": {
    "id": 0,
    "identity": null,
    "username": "example",
    "display_name": "example",
    "is_dismissed": true,
    "affiliation": "example"
  },
  "created_at": "2025-01-01T00:00:00Z",
  "mimetype": "example",
  "has_preview": true,
  "check_status": "ready"
}
```

{% endcut %}
{.table-cell}
||
||

_type_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
{% cut "**All of 1 type**" %}{.json-schema-combinators data-marker=and}

- **ResourceType**

  **Type**: [ResourceType](#entity-ResourceType)

  Page resource type:
  - `attachment`: An attached file.
  - `grid`: A dynamic table.

  _Enum:_{.json-schema-reset .json-schema-value} `attachment`, `grid`

{% endcut %}

Resource type: `attachment` for an attached file, or `grid` for a dynamic table

_Example:_{.json-schema-reset .json-schema-example} `attachment`
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "type": "attachment",
  "item": {
    "id": 0,
    "name": "example",
    "is_downloadable": true,
    "download_url": "example",
    "size": "example",
    "description": "example",
    "user": {
      "id": 0,
      "identity": null,
      "username": "example",
      "display_name": "example",
      "is_dismissed": true,
      "affiliation": "example"
    },
    "created_at": "2025-01-01T00:00:00Z",
    "mimetype": "example",
    "has_preview": true,
    "check_status": "ready"
  }
}
```

{% endcut %}

</div>

</div>

</div>

[*Deprecated]: No longer supported, please use an alternative and newer version.