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

Description

/product/ Description: The /product/ endpoint retrieves a list of products based on specified criteria. Users can filter the results using query parameters such as search query, pagination, sorting options, and product type. 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 products

page
integer
default:1

Page number for pagination

size
integer
default:10

Number of products per page

sort
enum<string>
default:updatedAt

Field to sort by. Standard fields include any product attribute (e.g., title, upc, releaseDate, updatedAt).

When statistics=true, additional sortable fields become available:

  • splits - Number of splits associated with the product
  • assets - Number of assets (tracks) associated with the product
  • count - Total stream/sales count from royalty data
  • royalty - Total royalty earnings
Available options:
updatedAt,
createdAt,
title,
upc,
releaseDate,
catalogNumber,
displayArtist,
splits,
assets,
count,
royalty
order
enum<string>
default:desc

Sort order ('asc' or 'desc')

Available options:
asc,
desc
artist
string

Filter by artist ID(s). Comma-separated for multiple

type
enum<string>

Filter by product type (Audio, Video, Ringtone). Comma-separated for multiple.

Available options:
Audio,
Video,
Ringtone
format
enum<string>

Filter by product format. Comma-separated for multiple.

Available options:
Single,
EP,
Album,
LP
status
enum<string>

Filter by product status. Comma-separated for multiple.

Available options:
Live,
Taken Down,
Scheduled,
Pending,
Error
splits
boolean
default:false

Whether to include splits information

statistics
boolean
default:false

Whether to include statistical data

asset
string

Filter by asset ID

attributes
string

Comma-separated list of attributes to include in the response

role
string

Filter by role

user
string

Filter by user ID

hasArtists
enum<string>

Filter products by artist linkage. true = products with artists, false = products without

Available options:
true,
false
hasSplits
enum<string>

Filter products by splits. true = products with splits configured, false = products without

Available options:
true,
false

Response

Success

message
string
products
object[]
totalPages
integer
currentPage
integer
pageSize
integer