Skip to main content
GET
/
file
/
sources
List all royalty sources
curl --request GET \
  --url https://api.royalti.io/file/sources \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "456e7890-e89b-12d3-a456-426614174001",
    "name": "spotify",
    "label": "Spotify",
    "type": "streaming"
  },
  {
    "id": "567e8901-e89b-12d3-a456-426614174002",
    "name": "apple_music",
    "label": "Apple Music",
    "type": "streaming"
  },
  {
    "id": "678e9012-e89b-12d3-a456-426614174003",
    "name": "youtube",
    "label": "YouTube",
    "type": "video"
  }
]
This endpoint requires authentication. Include your Bearer token in the Authorization header.

​
Description

List all royalty sources Returns a list of all available royalty sources that can be used for file processing. Filtering Options:
  • Default: Returns all active sources (backward compatible)
  • includeAll=false: Returns only tenant-associated sources (more secure, recommended)
Includes both public sources and tenant-specific custom sources.

​
Code Examples

const response = await fetch('https://api.royalti.io/file/sources', {
  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

​
includeAll
enum<string>
default:true

Controls source filtering behavior:

  • Not specified or "true": Returns all active sources (default for backward compatibility)
  • "false": Returns only sources associated with the tenant (more secure)
Available options:
true,
false

Response

Success - Array of sources

​
id
string

Royalty source ID

​
name
string

Internal source name (lowercase, unique)

​
label
string

Display name for UI

​
type
string

Source type or category