Skip to main content
GET
/
product
Get Products
curl --request GET \
  --url https://api.royalti.io/product/ \
  --header 'Authorization: Bearer <token>'
{
  "message": "Products retrieved successfully",
  "products": [
    {
      "id": "437307ed-b268-4ee0-867d-f67816a77ffa",
      "title": "Mavins sabi girl",
      "upc": "TEMP437307ed-b26",
      "displayArtist": "arya star",
      "createdAt": "2025-06-24T10:17:43.818Z",
      "updatedAt": "2025-06-24T10:17:43.818Z",
      "type": "Audio",
      "label": null,
      "releaseDate": "2022-02-01T00:00:00.000Z",
      "format": "Single",
      "version": null,
      "takedownDate": "2026-02-01T00:00:00.000Z",
      "status": "Live",
      "distribution": "Example Distribution",
      "mainGenre": [
        "Pop"
      ],
      "subGenre": [
        "Electronic"
      ],
      "explicit": null,
      "Artists": [
        {
          "id": "cfbb1259-c087-4118-8e11-f6e72bd60f89",
          "artistName": "",
          "type": "primary"
        },
        {
          "id": "c475576c-4e3f-45d4-846b-b84205b2fac0",
          "artistName": "NameArt",
          "type": "primary"
        }
      ],
      "ProductAssets": [
        {
          "AssetId": "007c9895-14a3-40e3-86c3-56d59787649f"
        },
        {
          "AssetId": "a3c06e35-1765-4a2e-8f98-afd61949ff2c"
        }
      ]
    }
  ],
  "totalPages": 50,
  "currentPage": 1,
  "filteredItems": 10
}
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. Method: GET Query Parameters:
ParameterTypeDescription
q (Optional)stringSearch query to filter products.
artist (Optional)stringFilter by artist ID(s). Comma-separated for multiple.
type (Optional)stringFilter by product type.
statistics (Optional)booleanWhether to include statistical data. Default: false
splits (Optional)booleanWhether to include splits information. Default: false
role (Optional)stringFilter by role.
user (Optional)stringFilter by user ID.
page (Optional)integerPage number for pagination. Default: 1
size (Optional)integerNumber of products per page. Default: 10
attributes (Optional)stringComma-separated list of attributes to include in the response.
asset (Optional)stringFilter by asset ID.
sort (Optional)stringField to sort by. Default: ‘updatedAt’
order (Optional)stringSort order (‘asc’ or ‘desc’). Default: ‘desc’

​
Code Examples

const response = await fetch('https://api.royalti.io/product/', {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${token}`,
  },
});

const data = await response.json();
console.log(data);

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
string

Filter by product type

​
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

Response

Success

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