Skip to main content
GET
/
defaultsettings
/
templates
/
popular
Get Popular Templates
curl --request GET \
  --url https://api.royalti.io/defaultsettings/templates/popular \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "message": "Popular templates retrieved successfully",
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "description": "<string>",
      "category": "content",
      "entityType": "catalog",
      "settings": {
        "content": {
          "type": "Audio",
          "format": "Single",
          "version": "<string>",
          "explicit": "explicit",
          "language": "<string>",
          "mainGenre": [
            "<string>"
          ],
          "subGenre": [
            "<string>"
          ],
          "contributors": {}
        },
        "business": {
          "label": "<string>",
          "copyright": "<string>",
          "publisher": "<string>",
          "copyrightOwner": "<string>",
          "distribution": "<string>",
          "status": "Live"
        },
        "ddex": {
          "enableDDEX": true,
          "labelName": "<string>",
          "resourceReference": "<string>",
          "grid": "<string>",
          "icpn": "<string>"
        },
        "validation": {
          "requireGenre": true,
          "requireLyrics": true,
          "requireDescription": true,
          "minimumTrackCount": 1,
          "maximumTrackCount": 2
        }
      },
      "isPublic": true,
      "isSystem": false,
      "usageCount": 0,
      "tags": [
        "<string>"
      ],
      "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ]
}

​
Description

GET /defaultsettings/templates/popular Description: Retrieve the most frequently used templates, sorted by usage count. Method: GET Query Parameters:
ParameterTypeDescriptionRequired
categorystringFilter by categoryNo
limitintegerNumber of results (default: 10)No

​
Code Examples

const response = await fetch('https://api.royalti.io/defaultsettings/templates/popular', {
  method: 'GET',
});

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

​
category
enum<string>
Available options:
content,
business,
ddex,
validation
​
limit
integer
default:10
Required range: 1 <= x <= 50

Response

Popular templates retrieved successfully

​
success
boolean
Example:

true

​
message
string
Example:

"Popular templates retrieved successfully"

​
data
object[]