q
: Search term to filter files by various fieldstype
: Filter files by type (royalty, invoice, receipt, report)column
: The column to sort by (createdAt, updatedAt, name, size, type)order
: The order of sorting (asc, desc)attributes
: Comma-separated list of attributes to include in the responsepage
: The page number for pagination (>= 1)size
: The number of records per page (>= 0)
Authentication
This endpoint requires authentication. Include your bearer token in the Authorization header.Query Parameters
Parameter | Type | In | Required | Description |
---|---|---|---|---|
q | string | query | ā | Search term to filter files by various fields |
type | string | query | ā | Filter files by type |
column | string | query | ā | The column to sort by |
order | string | query | ā | The order of sorting |
attributes | string | query | ā | Comma-separated list of attributes to include |
page | integer | query | ā | The page number for pagination |
size | integer | query | ā | The number of records per page |
Responses
ā 200 - Success
ā ļø 401 - undefined
ā 500 - undefined
Tags
File
Authorizations
JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"
Query Parameters
Search term to filter files by various fields
Filter files by type
Available options:
royalty
, invoice
, receipt
, report
The column to sort by
Available options:
createdAt
, updatedAt
, name
, size
, type
The order of sorting
Available options:
asc
, desc
Comma-separated list of attributes to include
The page number for pagination
Required range:
x >= 1
The number of records per page
Required range:
x >= 0