Skip to main content
GET
List Files

List Files

GET /files Retrieve a paginated list of uploaded files with support for filtering by type and status. Deleted files are excluded by default.

Features

  • Paginated results with configurable page sizes
  • Filter by document type and status
  • Exclude deleted files by default
  • Efficient querying with proper indexing

Parameters

Request

Response

Response Fields

Try It Out

Use the interactive playground above to test the list files endpoint. You can:
  1. Add your API key in the Authorization header
  2. Configure pagination with page and page_size parameters
  3. Apply filters by type (invoice, bank_statement) or status
  4. Execute the request to see paginated results
The playground allows you to experiment with different filter combinations.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page
integer
default:1

Page number

page_size
integer
default:20

Items per page

Required range: x <= 100
type
string

Filter by document type (invoice, bank_statement, etc.)

status
enum<string>

Filter by status

Available options:
pending,
processing,
completed,
failed,
deleted

Response

200 - application/json

Files retrieved successfully

success
boolean
Example:

true

data
object