Skip to main content
GET
Get File Upload Info
This endpoint requires authentication. Include your Bearer token in the Authorization header.

Description

Query Parameters:
  • q: Search term to filter files by various fields
  • type: 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 response
  • page: The page number for pagination (must be >= 1, default: 1)
  • size: The number of records per page (must be >= 0, default: 10)
Validation Rules:
  • page must be at least 1 (returns BadRequest error if < 1)
  • size must be non-negative (returns BadRequest error if < 0)
  • Invalid column values will be ignored and default to ‘createdAt’
  • Invalid order values will default to ‘desc’
Authorization:
  • Required role: user or higher

Code Examples

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"

Query Parameters

q
string

Search term to filter files by various fields

type
enum<string>

Filter files by type

Available options:
royalty,
invoice,
receipt,
report
column
enum<string>
default:updatedAt

The column to sort by

Available options:
createdAt,
updatedAt,
name,
size,
type
order
enum<string>
default:desc

The order of sorting

Available options:
asc,
desc
attributes
string

Comma-separated list of attributes to include

page
integer
default:1

The page number for pagination

Required range: x >= 1
size
integer
default:10

The number of records per page

Required range: x >= 0

Response

Success

success
boolean
default:true
message
string
files
object[]
total
integer
page
integer
size
integer
totalPages
integer