---
title: "List files"
method: GET
path: "/v1/files"
tags: ["Files"]
---

# List files

`GET /v1/files`

Retrieve existing files.

## Query parameters

- `take` number, nullable
- `skip` number, nullable
- `name` string
- `name__not` string
- `name__isNull` string
- `name__isNotNull` string
- `name__equals` string
- `name__contains` string
- `name__startsWith` string
- `name__endWith` string
- `customer_id` string
- `customer_id__not` string
- `customer_id__isNull` string
- `customer_id__isNotNull` string
- `customer_id__equals` string
- `customer_id__contains` string
- `customer_id__startsWith` string
- `customer_id__endWith` string

## Response `200`

- PaginatedFile
  - `meta` object, required
    - `total` number, required — Total of existing items.
    - `taken` number, required — Number of items returned.
    - `skipped` number, required — Number of items skipped.
  - `data` object[], required — List of File.
    - `id` string, required — File ID.
    - `name` string, required — File name.
    - `type` 'pdf' | 'doc' | 'docx' | 'xls' | 'xlsx' | 'ppt' | 'pptx' | 'txt' | 'csv' | 'jpeg' | 'png' | 'gif' | 'svg' | 'json' | 'xml', required — File type based on the MIME type. Supported file types: - `pdf`: PDF documents - `doc`: Microsoft Word documents (legacy) - `docx`: Microsoft Word documents - `xls`: Microsoft Excel spreadsheets (legacy) - `xlsx`: Microsoft Excel spreadsheets - `ppt`: Microsoft PowerPoint presentations (legacy) - `pptx`: Microsoft PowerPoint presentations - `txt`: Plain text files - `csv`: Comma-separated values files - `jpeg`: JPEG images - `png`: PNG images - `gif`: GIF images - `svg`: SVG vector images - `json`: JSON data files - `xml`: XML data files
    - `mimetype` string, required — MIME type of the file.
    - `customer_id` string, nullable, required — ID of the customer linked to the file.
    - `summary` string, nullable, required — AI-generated summary of the file content
    - `created_at` string, date-time, required — Date when the file was created.

---

[API](https://skmtc.dev/hyperline/apis/hyperline-api.md) · [All operations](https://skmtc.dev/hyperline/apis/hyperline-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/hyperline/hyperline-api/revisions/19fa5f22e39b/schema)