Skip to main content
GET
/
defaultsettings
/
templates
Get Templates
curl --request GET \
  --url https://api.royalti.io/defaultsettings/templates \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "message": "Templates retrieved successfully",
  "data": {
    "templates": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<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
          }
        },
        "description": "<string>",
        "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"
      }
    ],
    "count": 123,
    "limit": 123,
    "offset": 123
  }
}

​
Description

GET /defaultsettings/templates Description: Retrieve a list of default setting templates with advanced filtering and pagination. Method: GET Query Parameters:
ParameterTypeDescriptionRequired
categorystringFilter by categoryNo
entityTypestringFilter by entity typeNo
isPublicbooleanFilter by public visibilityNo
isSystembooleanFilter system templatesNo
tagsstringComma-separated tagsNo
searchstringSearch in name/descriptionNo
orderBystringSort field (usageCount, name, createdAt, updatedAt)No
orderDirectionstringSort direction (ASC, DESC)No
limitintegerResults per page (default: 50)No
offsetintegerPagination offsetNo

​
Code Examples

const response = await fetch('https://api.royalti.io/defaultsettings/templates', {
  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
​
entityType
enum<string>
Available options:
catalog,
asset,
product,
release
​
isPublic
boolean
​
isSystem
boolean
​
tags
string

Comma-separated list of tags

​
search
string

Search query for name/description

​
orderBy
enum<string>
default:createdAt
Available options:
usageCount,
name,
createdAt,
updatedAt
​
orderDirection
enum<string>
default:DESC
Available options:
ASC,
DESC
​
limit
integer
default:50
Required range: 1 <= x <= 100
​
offset
integer
default:0
Required range: x >= 0

Response

Templates retrieved successfully

​
success
boolean
Example:

true

​
message
string
Example:

"Templates retrieved successfully"

​
data
object