Skip to main content
GET
List all royalty sources
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. Authorization:
  • Required role: user or higher

Code Examples

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