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

Description

All filters are optional and additive (AND logic). Authorization:
  • Required role: user or higher
  • Required feature: royaltyAccess

Code Examples

Authorizations

Authorization
string
header
required

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

Query Parameters

startDate
string<date>

Filter files created on or after this date

endDate
string<date>

Filter files created on or before this date

status
enum<string>

Filter by file status

Available options:
pending,
processing,
processed,
decompressing,
decompressed,
uploaded,
failed,
expired,
pending_source
type
enum<string>

Filter by file type

Available options:
file,
royalty,
invoice,
receipt,
report
format
string

Filter by file format (e.g. csv, xlsx, zip)

source
string

Filter by royalty source name (e.g. Spotify, Apple Music)

Response

Summary retrieved successfully

status
enum<string>
Available options:
success
message
string
data
object