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

Description

Get Revenues Description: The /revenue/ endpoint retrieves a list of revenue records with filtering, pagination, and inclusion options. Authorization:
  • Required role: user or higher
Method: GET Query Parameters:

Code Examples

Authorizations

Authorization
string
header
required

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

Query Parameters

q
string

Search query to filter revenues

page
integer
default:1

Page number for pagination

size
integer
default:10

Number of revenues per page

sort
string
default:transactionDate

Field to sort by

order
enum<string>
default:desc

Sort order ('asc' or 'desc')

Available options:
asc,
desc
source
enum<string>

Filter by revenue source

Available options:
streaming,
sales,
licensing,
sync,
merchandise,
live_performance,
other
artist
string

Filter by artist ID

asset
string

Filter by asset ID

product
string

Filter by product ID

currency
string

Filter by currency

dateFrom
string<date>

Filter revenues from this date

dateTo
string<date>

Filter revenues to this date

include
string

Additional data to include (Artist, Asset, Product)

Response

Success

message
string
revenues
object[]
total
integer
page
integer
size
integer
totalPages
integer
summary
object