Get Products
/product/
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:
useror higher
GET
Query Parameters:
Code Examples
Authorizations
JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"
Query Parameters
Search query to filter products
Page number for pagination
Number of products per page
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 productassets- Number of assets (tracks) associated with the productcount- Total stream/sales count from royalty dataroyalty- Total royalty earnings
updatedAt, createdAt, title, upc, releaseDate, catalogNumber, displayArtist, splits, assets, count, royalty Sort order ('asc' or 'desc')
asc, desc Filter by artist ID(s). Comma-separated for multiple
Filter by product type (Audio, Video, Ringtone). Comma-separated for multiple.
Audio, Video, Ringtone Filter by product format. Comma-separated for multiple.
Single, EP, Album, LP Filter by product status. Comma-separated for multiple.
Live, Taken Down, Scheduled, Pending, Error Whether to include splits information
Whether to include statistical data
Filter by asset ID
Comma-separated list of attributes to include in the response
Filter by role
Filter by user ID
Filter products by artist linkage. true = products with artists, false = products without
true, false Filter products by splits. true = products with splits configured, false = products without
true, false