---
title: "Найти файлы"
method: GET
path: "/api/v1/files/search"
tags: ["Files"]
---

# Найти файлы

`GET /api/v1/files/search`

## Request

- Base URL: `https://erp.akeda.ru`
- URL: `https://erp.akeda.ru/api/v1/files/search`
- Auth: one of:
  - HTTP bearer
  - OAuth 2 (authorization code, authorization URL `https://erp.akeda.ru/oauth2/authorize`, token URL `https://erp.akeda.ru/oauth2/token`, scopes: `akeda:delegate`)

Ищет по именам и по извлечённому из документов тексту в пределах доступного смотрящему.

## Query parameters

- `q` string, required
- `root_id` string, uuid
- `limit` integer
- `offset` integer

## Headers

- `X-Tenant` string, required

## Response `200`

Найденные файлы

- object
  - `results` FilesSearchHit[], required
    - `file` FilesFile, required
      - `id` string, uuid, required
      - `folder_id` string, uuid, required
      - `root_id` string, uuid, required
      - `name` string, required
      - `external_url` string, uri: HTTP(S)-адрес внешнего ярлыка; отсутствует у обычных файлов
      - `extension` string, required
      - `mime_type` string, required
      - `size_bytes` integer, required
      - `version_no` integer, required
      - `version_id` string, uuid
      - `owner_id` integer, required
      - `created_by` integer, required
      - `updated_by` integer
      - `trashed_at` string, date-time
      - `created_at` string, date-time, required
      - `updated_at` string, date-time, required
      - `scan_status` 'pending' | 'scanning' | 'clean' | 'infected' | 'skipped' | 'error', required: skipped — содержимое крупнее порога проверки: оно выдаётся, но честно помечено непроверенным
      - `scan_verdict` string
      - `preview_status` 'pending' | 'processing' | 'ready' | 'unsupported' | 'error', required
      - `has_thumbnail` boolean, required
      - `is_favorite` boolean, required
      - `folder_name` string
      - `path` FilesBreadcrumb[]
        - `id` string, uuid, required
        - `name` string, required
    - `snippet` string
    - `matched` 'name' | 'content', required

## Other responses

- `400`: Некорректный запрос или нарушение бизнес-правила
- `401`: Сессия, ключ или кабинет не подтверждены
- `403`: Текущая роль не имеет требуемого права

---

[API](https://skmtc.dev/akeda/apis/akeda-erp-client-api.md) · [All operations](https://skmtc.dev/akeda/apis/akeda-erp-client-api/llms.txt) · [OpenAPI document](https://skmtc.dev/akeda/apis/akeda-erp-client-api/revisions/a99574d597cc?raw)
