---
title: "List the org's files"
method: GET
path: "/files"
tags: ["files"]
---

# List the org's files

`GET /files`

Returns one page of the org's file library, newest first, with the org's standing usage against its storage quota. Every file carries its source (upload or capture) and, for a capture, its surface and capture state. Filter with source, surface and session_id. Files persist until deleted and any ready file can be delivered to a phone the org holds.

## Query parameters

- `limit` integer — max items per page
- `offset` integer — pagination offset
- `q` string — filter by filename, case-insensitive substring match
- `source` 'upload' | 'capture' — only files of this source
- `surface` 'phone' — only captures off this surface
- `session_id` string, uuid — only files captured by this session
- `mime_type` string — only files of exactly this media type
- `min_size_bytes` integer — only files at least this many bytes (0 = no bound)
- `max_size_bytes` integer — only files at most this many bytes (0 = no bound)
- `created_after` string, date-time — only files registered at or after this time (RFC 3339)
- `created_before` string, date-time — only files registered at or before this time (RFC 3339)
- `sort` 'created_at' | 'filename' | 'size_bytes' | 'source' — field to sort by; source groups uploads and captures
- `order` 'asc' | 'desc' — sort direction

## Response `200`

OK

- FileListResponse — One page of the org's file library.
  - `$schema` string, uri — A URL to the JSON Schema for this object.
  - `files` FileSummary[], nullable, required — Library entries, newest first.
    - `attachment_url` string — Short-lived signed URL that downloads the file as an attachment under its name. Present only for ready files.
    - `bytes_transferred` integer — Bytes moved so far for an in-flight phone transfer. Absent until the phone reports progress.
    - `capture_error` string — Reason the capture failed, when it did. Present only for captures.
    - `capture_state` 'detected' | 'uploading' | 'ready' | 'skipped_size' | 'skipped_quota' | 'skipped_type' | 'dropped_teardown' | 'failed' — Capture lifecycle: detected/uploading while in flight, ready when usable, or a terminal skip/failure with its reason. Present only for captures.
    - `checksum` string — SHA-256 of the bytes, computed on the phone during a capture upload. Present only for captures.
    - `created_at` string, date-time, required — When the file was registered: upload registration, or capture detection.
    - `download_url` string — Short-lived signed URL to read the file's bytes. Present only for ready files; re-list to refresh an expired one.
    - `duration_seconds` integer — Video duration in seconds.
    - `filename` string, required — Original filename; used as the display name when the file lands on a phone.
    - `height` integer — Intrinsic pixel height of the source.
    - `id` string, required — File identifier. Unique across the whole library; deliverable to a phone regardless of source.
    - `mime_type` string, required — Declared MIME type, pinned by the presigned upload.
    - `on_phone_count` integer, required — Distinct phones currently holding or receiving a copy. Deleting the file recalls these.
    - `preview_state` 'processing' | 'ready' | 'unavailable', required — Whether the preview exists, is still being generated, or will never be available for this format.
    - `reel_url` string — Short-lived signed URL for the animated hover preview. Videos only; absent until generated.
    - `session_id` string — Session that produced the file. Present only for captures.
    - `size_bytes` integer, required — Declared size in bytes, pinned by the presigned upload.
    - `source` 'upload' | 'capture', required — How the file entered the library: upload (put in directly) or capture (lifted off a session).
    - `status` 'uploading' | 'ready', required — uploading until the object is verified in storage, then ready. For a capture, read capture_state for the fuller lifecycle.
    - `surface` 'phone' — Which surface a capture came off (phone today). Absent for a direct upload.
    - `thumbnail_url` string — Short-lived signed URL for the generated preview image. Absent while generation is pending, and permanently absent for formats without a preview.
    - `width` integer — Intrinsic pixel width of the source.
  - `total` integer, required — Total files matching the query.
  - `usage` FileUsage, required — The org's standing library usage against its quota.
    - `byte_limit` integer, required — Storage quota in bytes.
    - `file_count` integer, required — Files currently in the library.
    - `file_limit` integer, required — Maximum files the library will hold.
    - `total_bytes` integer, required — Total bytes currently stored.

## Other responses

- `default` — Error

---

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