---
title: "Get files in a storage folder, or all files on a storage"
method: GET
path: "/v1/storages/{storage_id}/files/"
---

# Get files in a storage folder, or all files on a storage

`GET /v1/storages/{storage_id}/files/`

## Request

- Base URL: `https://app.iconik.io/API/files`
- URL: `https://app.iconik.io/API/files/v1/storages/{storage_id}/files/`
- Auth: none declared. Required headers: `App-ID`, `Auth-Token`
- TypeScript: <https://skmtc.dev/iconik/apis/iconik-files/docs/v1/storages/:storage_id/files/get.ts> (a function with typed inputs; its response is checked against the schema)

Required roles:
 - can_list_storage_files

## Path parameters

- `storage_id` string, required

## Query parameters

- `path` string
- `path_separator` string
- `directory_path` string
- `checksum` string
- `per_page` integer
- `page` integer
- `scroll` boolean
- `scroll_id` string
- `sort` string
- `id` string
- `name` string
- `type` string
- `status` string
- `date_created` string
- `date_modified` string
- `original_name` string
- `size` string
- `asset_id` string
- `format_id` string
- `include_parent_statuses` boolean

## Headers

- `App-ID` string, required
- `Auth-Token` string, required

## Response `200`

Returns files

- FilesElasticSchema
  - `facets` object
  - `first_url` string
  - `last_url` string
  - `next_url` string
  - `objects` FileElasticSchema[]
    - `asset_id` string, uuid
    - `checksum` string, nullable
    - `date_created` string, date-time
    - `date_modified` string, date-time
    - `directory_path` string, required
    - `file_date_created` string, date-time
    - `file_date_modified` string, date-time
    - `file_set_id` string, uuid
    - `file_set_status` string, nullable
    - `format_id` string, uuid
    - `format_status` string, nullable
    - `id` string, uuid
    - `name` string: If not specified, name will be autogenerated based on `id` and `original_name`
    - `original_name` string, required
    - `parent_id` string, uuid, nullable
    - `size` integer
    - `status` 'OPEN' | 'GROWING' | 'AWAITED' | 'CLOSED' | 'FAILED' | 'ARCHIVED' | 'MISSING' | 'REDISCOVERED' | 'DELETED'
    - `storage_id` string, uuid
    - `template` string
    - `template_engine` 'SIMPLE' | 'JINJA2' | 'null', nullable
    - `type` 'FILE' | 'DIRECTORY' | 'SYMLINK' | 'SEQUENCE', required
    - `user_id` string, uuid, nullable
    - `version_id` string, uuid
  - `page` integer
  - `pages` integer
  - `per_page` integer
  - `prev_url` string
  - `scroll_id` string
  - `total` integer

## Other responses

- `400`: Bad request
- `401`: Token is invalid
- `404`: No files found
- `default`: Error response

---

[API](https://skmtc.dev/iconik/apis/iconik-files.md) - [All operations](https://skmtc.dev/iconik/apis/iconik-files/llms.txt) - [OpenAPI document](https://skmtc.dev/iconik/apis/iconik-files/revisions/ed57d13791a2?raw)