Skip to main content
GET
/
files
List Files
curl --request GET \
  --url https://api.invaro.ai/api/v1/files \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": {
    "files": [
      {
        "id": "72f574a0-b3d2-4a0f-8527-f542e6ea7500",
        "filename": "invoice.pdf",
        "file_id": "1234567890_invoice.pdf",
        "type": "invoice",
        "status": "pending",
        "size": 84898,
        "created_at": "2024-01-07T10:00:00Z",
        "completed_at": null
      }
    ],
    "page": 1,
    "page_size": 10,
    "total": 25
  }
}

​
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

ParameterTypeDefaultDescription
pageinteger1Page number
page_sizeinteger20Items per page (max: 100)
typestring-Filter by document type (invoice, bank_statement, etc.)
statusstring-Filter by status (pending, processing, completed, failed, deleted)

​
Request

curl "https://api.invaro.ai/api/v1/files?page=1&page_size=10&type=invoice" \
  -H "Authorization: Bearer your_api_key"

​
Response

{
  "success": true,
  "data": {
    "files": [
      {
        "id": "72f574a0-b3d2-4a0f-8527-f542e6ea7500",
        "filename": "invoice.pdf",
        "file_id": "1234567890_invoice.pdf",
        "type": "invoice",
        "status": "pending",
        "size": 84898,
        "created_at": "2024-01-07T10:00:00Z",
        "completed_at": null
      }
    ],
    "page": 1,
    "page_size": 10,
    "total": 25
  }
}

​
Response Fields

FieldTypeDescription
idstringUnique file identifier
filenamestringOriginal filename
file_idstringInternal file storage identifier
typestringDocument type
statusstringProcessing status
sizeintegerFile size in bytes
created_atstringUpload timestamp (ISO 8601)
completed_atstringProcessing completion timestamp
pageintegerCurrent page number
page_sizeintegerItems per page
totalintegerTotal number of files

​
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