Skip to main content
GET
/
defaultsettings
/
{entityType}
/
{entityId}
Get Default Settings
curl --request GET \
  --url https://api.royalti.io/defaultsettings/{entityType}/{entityId} \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "message": "Default settings retrieved successfully",
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "TenantId": 1,
      "entityType": "artist",
      "entityId": "660e8400-e29b-41d4-a716-446655440001",
      "category": "content",
      "settings": {
        "content": {
          "type": "Audio",
          "format": "Single",
          "mainGenre": [
            "Pop",
            "Electronic"
          ]
        }
      },
      "isActive": true,
      "priority": 0,
      "createdAt": "2024-01-01T00:00:00Z",
      "updatedAt": "2024-01-01T00:00:00Z"
    }
  ]
}

​
Description

GET /defaultsettings// Description: Retrieve default settings for a specific entity. You can filter by category and include/exclude inactive settings. Entity Types:
  • tenant - Workspace-wide defaults (entityId should be omitted or ‘global’)
  • catalog - Catalog-level defaults (entityId should be omitted or ‘global’)
  • label - Label-specific defaults (entityId required)
  • artist - Artist-specific defaults (entityId required)
  • user - User-specific defaults (entityId required)
Method: GET Path Parameters:
ParameterTypeDescriptionRequired
entityTypestringType of entity (tenant, label, artist, user, catalog)Yes
entityIduuidEntity ID (optional for tenant/catalog, required for others)Conditional
Query Parameters:
ParameterTypeDescriptionRequired
categorystringFilter by category (content, business, ddex, validation)No
includeInactivebooleanInclude inactive settingsNo

​
Code Examples

const response = await fetch('https://api.royalti.io/defaultsettings/example-id/example-id', {
  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}"

Path Parameters

​
entityType
enum<string>
required

Type of entity

Available options:
tenant,
label,
artist,
user,
catalog
​
entityId
string<uuid>
required

Entity ID (optional for tenant/catalog)

Query Parameters

​
category
enum<string>

Filter by settings category

Available options:
content,
business,
ddex,
validation
​
includeInactive
boolean
default:false

Include inactive settings in results

Response

Successfully retrieved default settings

​
success
boolean
Example:

true

​
message
string
Example:

"Default settings retrieved successfully"

​
data
object[]