Skip to main content

Royalti.io API home page

Getting Started

Welcome to Royalti.io API
Quick Start Guide
Authentication Guide

Guides

Release Management Guide
Royalty Management Guide
Payment Processing Guide
DDEX Integration Guide
Webhook Integration Guide

Changelog

API Changelog

Accounting

GET
Get Accounting Statistics
GET
Get Transactions Summary
GET
Get Monthly Transactions
GET
Get Transactions
GET
Get Current Due Amount
GET
Refresh Accounting Data
GET
Refresh Accounting Statistics
GET
Get Total Due Amount

Artist

GET
Get Artists
POST
Create Artist
POST
Create Bulk Artists
POST
Update Bulk Artist Splits
GET
Get Artist
PUT
Update Artist
DEL
Delete Artist
PUT
Merge Artists
GET
Get Artist Stats
GET
Get Artist Assets
GET
Get Artist Products
POST
Download Artists CSV
POST
Delete Bulk Artists
GET
Get all default splits for an artist
POST
Create new default splits for an artist
GET
Get default splits by type for an artist
PUT
Update default splits by type for an artist
DEL
Delete default splits by type for an artist

Asset

GET
Get all assets
POST
Create a new asset
POST
Create multiple assets in bulk
POST
Set bulk splits for multiple assets
POST
Delete multiple assets in bulk
PUT
Set default split for multiple assets
POST
Bulk delete splits for multiple assets
POST
Download asset data as CSV
GET
Get asset by ID
PUT
Update an asset
DEL
Delete an asset
PUT
Update asset artists
GET
Get asset statistics
PUT
Set default split for an asset
POST
Upload media for an asset
GET
Get works for a recording
DEL
Delete media for an asset

Auth

POST
Set Password
POST
Forgot password
PATCH
Reset password
POST
import data
GET
Get logged in users data
GET
Get new access token
POST
Logout
POST
Invite user
GET
Initiate Google OAuth login
GET
Google OAuth callback
GET
Initiate LinkedIn OAuth login
GET
LinkedIn OAuth callback
GET
Initiate Facebook OAuth login
GET
Facebook OAuth callback
GET
Get connected social providers
POST
Link a social provider
DEL
Unlink a social provider
POST
Verify email
POST
Login with a magic link
POST
Login

Checklists

GET
Check Royalty Assets
GET
Check Royalty Products
GET
Check Assets Splits
GET
Check Products Splits
GET
Check All Splits
GET
Check Missing Royalty Splits
GET
Check Artist Splits Users

Ddex

POST
Generate ERN for a Product
POST
Generate ERN in batch
POST
Queue MEAD generation for a Product
PUT
Update MEAD metadata for an entity
GET
List DDEX messages
GET
Get a DDEX message
POST
Validate a DDEX message
GET
Get a signed download URL for a message
POST
Queue message delivery
POST
Queue delivery for multiple messages
POST
Retry delivery for a failed message
GET
Get delivery status for a message
GET
Get delivery logs for a message
POST
Test connection to a DDEX provider
POST
Test connection to all configured DDEX providers
GET
List DDEX queue jobs (tenant-scoped)
GET
Get a single DDEX queue job (tenant-scoped)
GET
Get logs for a DDEX queue job (tenant-scoped)
GET
Get DDEX monitoring dashboard for the current tenant
GET
List global DDEX providers
GET
Get provider details
GET
Get provider statistics for tenant
GET
List tenant provider configurations
POST
Create tenant provider configuration
PUT
Update tenant provider configuration
DEL
Delete tenant provider configuration

Expense

GET
Get Expenses
POST
Create Expense
POST
Create Bulk Expenses
GET
Get Expense
PUT
Update Expense
POST
Delete Bulk Expenses

File

POST
Upload Royalty File
PUT
Process/Decompress Royalty File
GET
Get File Metadata
DEL
Delete royalty file and associated BigQuery table
GET
Get File Upload Info
POST
Generate Royalty Report File
POST
Resend Pending Files
POST
Get File Upload URL
POST
Upload File from Google Drive
POST
Get Google Drive Signed URL
POST
Confirm File Detection
POST
Confirm Upload Completion
POST
Get File Upload URL (Legacy)

Integration

GET
Get All Integrations
GET
Get Integration Info
GET
List Workspace Integrations
POST
Create Workspace Integration
PUT
Update Workspace Integration
DEL
Delete Workspace Integration
GET
Get Workspace Integration Info

Label

POST
Create Label
GET
List Label Access
POST
Add Label Access
PATCH
Update Label Access
DEL
Remove Label Access
GET
Get Label Settings
PUT
Update Label Settings
GET
Get Label Hierarchy
GET
Get Label by ID
PUT
Update Label
DEL
Delete Label
POST
Add Artist to Label
DEL
Remove Artist from Label
POST
Add Product to Label
DEL
Remove Product from Label

Notifications

GET
Get Notifications
GET
Get Unread Notification Count
PATCH
Mark All Notifications as Read
PATCH
Mark Notification as Read
GET
Get Notification Preferences
PUT
Update Notification Preferences

Payment Requests

GET
Get Payment Requests
POST
New Payment Request
GET
Get Payment Request
PUT
Update Payment Request
DEL
Delete Payment Request
POST
Delete Bulk Payment Requests
PATCH
Approve Payment Request
PATCH
Decline Payment Request

Payment Settings

GET
Get Payment Settings
POST
Create New Payment Setting
GET
Get Payment Setting
PUT
Update Payment Setting
DEL
Delete Payment Setting
POST
Delete Bulk Payment Settings

Payments

GET
Get Payments
POST
Create Payment
GET
Get Payment
PUT
Update Payment
DEL
Delete Payment
POST
Create Bulk Payments
POST
Delete Bulk Payments

Product

GET
Get Products
POST
Create Product
GET
Get Product
PUT
Update Product
DEL
Delete Product
PUT
Update Product Artists
PUT
Update Product Assets
GET
Get Product Stats
PUT
Set Default Split for Product from Artist
POST
Download Product Metadata
POST
Download Products CSV
POST
Upload Product Media
DEL
Delete Product Media
POST
Create Bulk Products
PUT
Update Bulk Product Splits
POST
Delete Bulk Products
PUT
Set Default Split for Bulk Products
POST
Delete Splits from Bulk Products

Release

GET
Get Releases
POST
Create Release
GET
Get Release Statistics
GET
Get Release by ID
PUT
Update Release
DEL
Delete Release
POST
Submit Release for Review
POST
Review Release (Admin Only)
POST
Add Feedback to Release
POST
Revert Release Status (Admin Only)
POST
Upload Media Files to Release
POST
Submit Media Links to Release
GET
Get Release Media
DEL
Delete Release Media
POST
Upload Media File to Track
POST
Submit Media Link to Track
GET
Get Track Media
DEL
Delete Track Media
POST
Create a new track (release asset)
PUT
Update a track (release asset)
DEL
Delete a track (release asset)
POST
Reorder Release Tracks
POST
Link Existing Asset to Release

Revenue

GET
Get Revenues
POST
Create Revenue
POST
Create Bulk Revenues
GET
Get Revenue
PUT
Update Revenue
DEL
Delete Revenue
POST
Delete Bulk Revenues

Royalties

GET
Get Royalties Summary
GET
Get Royalties grouped by month (Accounting period)
GET
Get Royalties grouped by month (Sale period)
GET
Get Royalties grouped by DSP (Providers)
GET
Get Royalties grouped by country
GET
Get Royalties grouped by artist
GET
Get Royalties grouped by product
GET
Get Royalties grouped by asset
GET
Get Royalties grouped by table source
GET
Get Royalties grouped by sale type
GET
Get Royalties grouped by aggregator

Sources

GET
List All Royalty Sources (Admin)
POST
Create Royalty Source (Admin)
GET
Get Royalty Source by ID (Admin)
PUT
Update Royalty Source (Admin)
DEL
Delete Royalty Source (Admin)
GET
List Tenant Sources
POST
Add Tenant Source
GET
Get Tenant Source by ID
PUT
Update Tenant Source
POST
Activate Tenant Source
POST
Deactivate Tenant Source

Splits

GET
Get splits
POST
Create split
POST
Create Default Splits
POST
Bulk delete Splits
DEL
Bulk delete catalog splits
POST
Match Splits
GET
Get Split
PUT
Update Split
DEL
Delete Split

User

GET
Get Users
POST
Create User
GET
List workspace invites
POST
Resend workspace invite
POST
Cancel workspace invite
POST
Create Bulk User
GET
Get User
PATCH
Update User
DEL
Delete User
PUT
Add User to Tenant
GET
Get User Stats
GET
Get User Monthly Stats
GET
Get User Artists
GET
Get User Assets
GET
Get User Products
POST
Download User Data
POST
Bulk Delete Users
DEL
Remove User Email
POST
Create Bulk Entity

Vertofx

POST
Add VertoFx Integrations
PUT
Update VertoFx Integration
DEL
Delete VertoFx Integration
GET
Get All VertoFx Integrations
GET
Get VertoFx Integration Info
GET
Get Verto Wallets
GET
Get Beneficiaries List
POST
Create Beneficiary
GET
Get Beneficiary Details
PUT
Update VertoFx Beneficiary
DEL
Delete VertoFx Beneficiary
GET
Get VertoFx Purpose Codes
POST
Create VertoFx Payment Request (v2)
POST
Link Verto Beneficiary to User
DEL
Unlink Verto Beneficiary From User
GET
Get VertoFx Payment Requests
POST
Create VertoFx Payment Request
GET
Get VertoFx Payment Request Details

Webhooks

POST
Royalty file status update webhook
POST
Download status update webhook
POST
VertoFX payment status webhook

404

Page Not Found

We couldn't find the page. Maybe you were looking for one of these pages below?

Webhook Integration Guide Download status update webhook Royalty file status update webhook

⌘I