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

# List files

`GET /files`

List and filter files.

## Query parameters

- `limit` integer
- `starting_after` string, uuid
- `sort_order` 'asc' | 'desc'
- `start_date` string, date
- `end_date` string, date
- `status` 'created' | 'approved' | 'canceled' | 'sent' | 'rejected' | 'processed' | 'received' — The status of the file.
- `category` 'bank_file' | 'payment_file' | 'report_file' | 'return_request_file' | 'return_file' | 'account_report' | 'account_statement' | 'account_notification' | 'inquiry_category' | 'denied_inquiry_file' | 'denied_return_request_file' | 'error_file_format' | 'unknown_file_format' | 'forwarded_message' — The category of the file.
- `direction` 'incoming' | 'outgoing' — The direction of the file.
- `format` 'pain.001' | 'pain.002' | 'pain.008' | 'pacs.002' | 'pacs.003' | 'pacs.004' | 'pacs.007' | 'pacs.008' | 'pacs.028' | 'camt.027' | 'camt.029' | 'camt.052' | 'camt.053' | 'camt.054' | 'camt.056' | 'camt.087' | 'mt.950' | 'head.002' | 'error.format' | 'unknown.format' | 'multiple.formats' | 'custom.format' — The format of the file.
- `connected_account_id` string, uuid

## Response `200`

200

- object
  - `records` FileDetails[], required
    - `id` string, required — The UUID of the file.
    - `object` 'file', required — Label used to identify this kind of object.
    - `connected_account_id` string, uuid, required — The ID of the connected account used to send or receive the file.
    - `connected_account_ids` string[], required — The IDs of the connected accounts used to send or receive the file.
    - `direction` 'outgoing' | 'incoming', required — The transfer direction for the file_id: - `outgoing` for files sent or to be sent to the bank - `incoming` for files received from the bank
    - `category` 'bank_file' | 'payment_file' | 'report_file' | 'return_request_file' | 'return_file' | 'account_report' | 'account_statement' | 'account_notification' | 'inquiry_category' | 'denied_inquiry_file' | 'denied_return_request_file' | 'error_file_format' | 'unknown_file_format' | 'forwarded_message', required — The category of the file.
    - `format` string, required — The format of the file.
    - `filename` string, required — The name of the file.
    - `size` integer, required — The size of the file, expressed in bytes.
    - `summary` object, required — A summary of the file, depending on its content.
    - `status` 'created' | 'approved' | 'canceled' | 'sent' | 'rejected' | 'processed' | 'received', required — The status of the file.
    - `bank_data` object, required — Bank data, such as message ID, in JSON `key:value` format.
      - `message_ids` string[], required
    - `status_details` string, required — The details of the status of this file, such as the rejection reason for instance.
    - `created_at` string, date-time, required — The UTC timestamp of the creation of the file.

## Other responses

- `400` — 400

---

[API](https://skmtc.net/numeral/apis/payments.md) · [All operations](https://skmtc.net/numeral/apis/payments/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/numeral/payments/revisions/220f101cc2ef/schema)