GET
/
file
/
Get File Upload Info
curl --request GET \
  --url https://server26-dot-royalti-project.uc.r.appspot.com/file/ \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "message": "Files retrieved successfully",
  "files": [
    {
      "id": "file-uuid-123",
      "name": "export.csv",
      "originalname": "export.csv",
      "type": "royalty",
      "size": 1024000,
      "mimetype": "text/csv",
      "uploadType": "royalty",
      "status": "processed",
      "royaltySource": "testsource",
      "accountingPeriod": "2017-05-01",
      "salePeriod": "2017-01-01",
      "createdAt": "2024-12-12T10:30:00.000Z",
      "updatedAt": "2024-12-12T10:35:00.000Z",
      "downloadUrl": "https://storage.googleapis.com/royalti-uploads/processed/export.csv"
    }
  ],
  "total": 50,
  "page": 1,
  "size": 10,
  "totalPages": 5
}

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:createdAt

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

200
application/json

Success

The response is of type object.