Skip to main content
GET
Get financial files

Authorizations

Authorization
string
header
required

Bearer authentication using a JWT token. Provide a valid access token. Authorization header format: Authorization: Bearer <token>.

Headers

Requester-Organization-ID
string<uuid>
required

The unique identifier of the organization making the request. This ID is used to authorize the requester within the system.

Example:

"054b4106-174b-46b0-97f8-86d8d7b6f0af"

Target-Organization-ID
string<uuid>
required

The unique identifier of the organization that is the target of the request. The Target-Organization-ID may match the Requester-Organization-ID if the requester accesses their own resources. If the Target-Organization-ID differs from the Requester-Organization-ID, the requester can access third-party resources if the requester has a connection with the target organization and is authorized to perform such actions.

Example:

"123e4567-e89b-12d3-a456-426614174000"

Path Parameters

org_id
string<uuid>
required

Unique identifier of the organization

Example:

"a3c9e8f1-2b4d-4c6e-8f0a-1b2c3d4e5f60"

Query Parameters

statuses
enum<string>[] | null

Optional set of file statuses to filter the results

Available options:
uploaded,
processing,
valid,
invalid,
failed
order_by
enum<string>
default:uploaded_at

Field to sort the results by

Available options:
created_at,
updated_at,
uploaded_at,
original_filename
order_dir
enum<string>
default:desc

Sort direction: ascending ('asc') or descending ('desc')

Available options:
asc,
desc
limit
integer
required

Maximum number of results to return in a single request

Required range: x <= 100
Examples:

10

50

offset
integer
required

Number of items to skip before starting to collect the results

Required range: x >= 0
Examples:

0

20

Response

Successful Response

items
FinancialFile · object[]
required

List of financial files returned by the query

total_items
integer
required

Total number of financial files matching the query, ignoring pagination

Required range: x >= 0
Examples:

1

25

100