Skip to main content
GET
/
product
/
Get Products
curl --request GET \
  --url https://server26-dot-royalti-project.uc.r.appspot.com/product/ \
  --header 'Authorization: Bearer <token>'
{
  "message": "Products retrieved successfully",
  "products": [
    {
      "id": "77339e1c-f962-447c-bf13-8fc047d4f8d2",
      "title": "Mavins sabi girl",
      "displayArtist": "arya star",
      "type": "Audio",
      "upc": "AB12fdfdg348vvfv67890ff",
      "status": "Live"
    }
  ],
  "total": 50,
  "page": 1,
  "size": 10
}
/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.
page (Optional)integerPage number for pagination. Default: 1
size (Optional)integerNumber of products per page. Default: 10
sort (Optional)stringField to sort by. Default: ‘updatedAt’
order (Optional)stringSort order (‘asc’ or ‘desc’). Default: ‘desc’
artist (Optional)stringFilter by artist ID(s). Comma-separated for multiple.
type (Optional)stringFilter by product type.
splits (Optional)booleanWhether to include splits information. Default: false
statistics (Optional)booleanWhether to include statistical data. Default: false

Authentication

This endpoint requires authentication. Include your bearer token in the Authorization header.

Query Parameters

ParameterTypeInRequiredDescription
qstringquerySearch query to filter products
pageintegerqueryPage number for pagination
sizeintegerqueryNumber of products per page
sortstringqueryField to sort by
orderstringquerySort order (‘asc’ or ‘desc’)
artiststringqueryFilter by artist ID(s). Comma-separated for multiple
typestringqueryFilter by product type
splitsbooleanqueryWhether to include splits information
statisticsbooleanqueryWhether to include statistical data

Responses

✅ 200 - Success

⚠️ 401 - Unauthorized

❌ 500 - Internal Server Error

Tags

Product

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
string
default:updatedAt

Field to sort by

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

Response

Success

message
string
products
object[]
total
integer
page
integer
size
integer
I