# Royalti.io API

## Docs

- [Get Current Due Amount](https://apidocs.royalti.io/api-reference/accounting/get-accounting-getcurrentdue.md): **Get Current Due Amount**
- [Get Total Due Amount](https://apidocs.royalti.io/api-reference/accounting/get-accounting-gettotaldue.md): **Get Total Due Amount**
- [Get User Accounting Statistics](https://apidocs.royalti.io/api-reference/accounting/get-accounting-id-stats.md): **Get User Accounting Statistics**
- [Refresh Accounting Data (Synchronous)](https://apidocs.royalti.io/api-reference/accounting/get-accounting-refresh.md): **Refresh Accounting Data**
- [Refresh Stats and Accounting Pipeline (Async)](https://apidocs.royalti.io/api-reference/accounting/get-accounting-refreshstats.md): **Refresh Stats and Accounting Pipeline**
- [Get Tenant Transactions](https://apidocs.royalti.io/api-reference/accounting/get-accounting-transactions.md): **Get Tenant Transactions**
- [Get Monthly Transaction Breakdown](https://apidocs.royalti.io/api-reference/accounting/get-accounting-transactions-monthly.md): **Get Monthly Transaction Breakdown**
- [Get Transactions Summary](https://apidocs.royalti.io/api-reference/accounting/get-accounting-transactions-summary.md): **Get Transactions Summary**
- [Delete Artist](https://apidocs.royalti.io/api-reference/artist/delete-artist-id.md): **artist/{id}**
- [Delete default splits by type for an artist](https://apidocs.royalti.io/api-reference/artist/delete-artist-id-splits-id.md): **artist/{id}/splits/{type}**
- [Get Artists](https://apidocs.royalti.io/api-reference/artist/get-artist.md): **/artist/**
- [Get Artist](https://apidocs.royalti.io/api-reference/artist/get-artist-id.md): **artist/{id}**
- [Get Artist Assets](https://apidocs.royalti.io/api-reference/artist/get-artist-id-assets.md): **artist/{id}/assets**
- [Get Artist Products](https://apidocs.royalti.io/api-reference/artist/get-artist-id-products.md): **artist/{id}/products**
- [Get all default splits for an artist](https://apidocs.royalti.io/api-reference/artist/get-artist-id-splits.md): **artist/{id}/splits**
- [Get default splits by type for an artist](https://apidocs.royalti.io/api-reference/artist/get-artist-id-splits-id.md): **artist/{id}/splits/{type}**
- [Get Artist Stats](https://apidocs.royalti.io/api-reference/artist/get-artist-stats-id.md): **artist/stats/{id}**
- [Create Artist](https://apidocs.royalti.io/api-reference/artist/post-artist.md): **artist/**
- [Create Bulk Artists](https://apidocs.royalti.io/api-reference/artist/post-artist-bulk.md): **artist/bulk**
- [Delete Bulk Artists](https://apidocs.royalti.io/api-reference/artist/post-artist-bulk-delete.md): **artist/bulk/delete**
- [Update Bulk Artist Splits](https://apidocs.royalti.io/api-reference/artist/post-artist-bulksplit.md): **artist/bulksplit**
- [Download Artists CSV](https://apidocs.royalti.io/api-reference/artist/post-artist-download-csv.md): **artist/download/csv**
- [Create new default splits for an artist](https://apidocs.royalti.io/api-reference/artist/post-artist-id-splits.md): **artist/{id}/splits**
- [Update Artist](https://apidocs.royalti.io/api-reference/artist/put-artist-id.md): **artist/{id}**
- [Merge Artists](https://apidocs.royalti.io/api-reference/artist/put-artist-id-merge.md): **artist/{id}/merge**
- [Update default splits by type for an artist](https://apidocs.royalti.io/api-reference/artist/put-artist-id-splits-id.md): **artist/{id}/splits/{type}**
- [Delete an asset](https://apidocs.royalti.io/api-reference/asset/delete-asset-id.md): Delete a specific asset by its ID.
- [Delete media for an asset](https://apidocs.royalti.io/api-reference/asset/delete-asset-id-media-id.md): Deletes a specific media file (e.g., audio, artwork) associated with an asset.
- [Get all assets](https://apidocs.royalti.io/api-reference/asset/get-asset.md): Retrieve a paginated list of assets. Supports filtering, sorting, and searching.
- [Get asset by ID](https://apidocs.royalti.io/api-reference/asset/get-asset-id.md): Retrieve detailed information about a specific asset by its ID.
- [Get asset statistics](https://apidocs.royalti.io/api-reference/asset/get-asset-id-stats.md): Retrieve statistics for a specific asset.
- [Get works for a recording](https://apidocs.royalti.io/api-reference/asset/get-asset-id-works.md): Retrieve works associated with a specific recording.
- [Create a new asset](https://apidocs.royalti.io/api-reference/asset/post-asset.md): Create a new asset with the provided details. This endpoint allows you to create a new asset with properties like title, artist information, and metadata.
- [Create multiple assets in bulk](https://apidocs.royalti.io/api-reference/asset/post-asset-bulk.md): Create multiple assets in a single request. This is more efficient than making multiple individual requests.
- [Delete multiple assets in bulk](https://apidocs.royalti.io/api-reference/asset/post-asset-bulk-delete.md): Delete multiple assets by their IDs in a single request.
- [Bulk delete splits for multiple assets](https://apidocs.royalti.io/api-reference/asset/post-asset-bulk-deletesplit.md): Deletes all splits associated with the specified assets where ProductId is null (asset-level splits).
- [Set bulk splits for multiple assets](https://apidocs.royalti.io/api-reference/asset/post-asset-bulksplits.md): Update splits for multiple assets in a single request.
- [Download asset data as CSV](https://apidocs.royalti.io/api-reference/asset/post-asset-download-csv.md): Download asset data in CSV format for the specified asset IDs.
- [Upload media for an asset](https://apidocs.royalti.io/api-reference/asset/post-asset-id-media.md): Upload media files (e.g., audio, artwork) for an asset.
- [Set default split for multiple assets](https://apidocs.royalti.io/api-reference/asset/put-asset-bulk-defaultsplit.md): Set the default split for multiple assets in a single request.
- [Update an asset](https://apidocs.royalti.io/api-reference/asset/put-asset-id.md): Update an existing asset's information.
- [Update asset artists](https://apidocs.royalti.io/api-reference/asset/put-asset-id-artists.md): Update the artists associated with an asset.
- [Set default split for an asset](https://apidocs.royalti.io/api-reference/asset/put-asset-id-setdefaultsplit.md): Set the default split for an asset.
- [Unlink a social provider](https://apidocs.royalti.io/api-reference/auth/delete-auth-social-id-unlink.md): Unlink a social provider from the current user's account
- [Get logged in users data](https://apidocs.royalti.io/api-reference/auth/get-auth.md): **/auth/**
- [Get new access token](https://apidocs.royalti.io/api-reference/auth/get-auth-authtoken.md): **/auth/authtoken**
- [Initiate Facebook OAuth login](https://apidocs.royalti.io/api-reference/auth/get-auth-facebook.md): Initiates the Facebook OAuth login flow. Users will be redirected to Facebook's login page.
- [Facebook OAuth callback](https://apidocs.royalti.io/api-reference/auth/get-auth-facebook-callback.md): Callback URL that Facebook will redirect to after authentication
- [Initiate Google OAuth login](https://apidocs.royalti.io/api-reference/auth/get-auth-google.md): Initiates the Google OAuth login flow. Users will be redirected to Google's login page.
- [Google OAuth callback](https://apidocs.royalti.io/api-reference/auth/get-auth-google-callback.md): Callback URL that Google will redirect to after authentication
- [Initiate LinkedIn OAuth login](https://apidocs.royalti.io/api-reference/auth/get-auth-linkedin.md): Initiates the LinkedIn OAuth login flow. Users will be redirected to LinkedIn's login page.
- [LinkedIn OAuth callback](https://apidocs.royalti.io/api-reference/auth/get-auth-linkedin-callback.md): Callback URL that LinkedIn will redirect to after authentication
- [Get connected social providers](https://apidocs.royalti.io/api-reference/auth/get-auth-social-providers.md): Retrieve a list of social providers connected to the current user's account
- [Reset password](https://apidocs.royalti.io/api-reference/auth/patch-auth-resetpassword.md): **/auth/resetpassword**
- [Forgot password](https://apidocs.royalti.io/api-reference/auth/post-auth-forgotpassword.md): **/auth/forgotpassword**
- [import data](https://apidocs.royalti.io/api-reference/auth/post-auth-importdata.md): **/auth/importdata**
- [Invite user](https://apidocs.royalti.io/api-reference/auth/post-auth-invite.md): **/auth/invite**
- [Login](https://apidocs.royalti.io/api-reference/auth/post-auth-login.md): **/auth/login**
- [Login with a magic link](https://apidocs.royalti.io/api-reference/auth/post-auth-loginlink.md): Request a magic login link to be sent to the user's email
- [Logout](https://apidocs.royalti.io/api-reference/auth/post-auth-logout.md): **/auth/logout**
- [Set Password](https://apidocs.royalti.io/api-reference/auth/post-auth-setpassword.md): Sets a new password for a user after they have verified their email.
- [Link a social provider](https://apidocs.royalti.io/api-reference/auth/post-auth-social-id-link.md): Link a social provider to the current user's account
- [Verify email](https://apidocs.royalti.io/api-reference/auth/post-auth-verify.md): Verify a user's email address using a verification token
- [Check All Splits](https://apidocs.royalti.io/api-reference/checklists/get-checklist-allsplits.md): **/checklist/allsplits**
- [Check Artist Splits Users](https://apidocs.royalti.io/api-reference/checklists/get-checklist-artistsplits.md): **/checklist/artistsplits**
- [Check Assets Splits](https://apidocs.royalti.io/api-reference/checklists/get-checklist-assetsplits.md): **/checklist/assetsplits**
- [Check Missing Royalty Splits](https://apidocs.royalti.io/api-reference/checklists/get-checklist-missingroyaltysplits.md): **/checklist/missingroyaltysplits**
- [Check Products Splits](https://apidocs.royalti.io/api-reference/checklists/get-checklist-productsplits.md): **/checklist/productsplits**
- [Check Royalty Assets](https://apidocs.royalti.io/api-reference/checklists/get-checklist-royaltyassets.md): **/checklist/royaltyassets**
- [Check Royalty Products](https://apidocs.royalti.io/api-reference/checklists/get-checklist-royaltyproducts.md): **/checklist/royaltyproducts**
- [Delete tenant provider configuration](https://apidocs.royalti.io/api-reference/ddex/delete-ddex-tenant-providers-id.md): Delete tenant provider configuration
- [Get delivery logs for a message](https://apidocs.royalti.io/api-reference/ddex/get-ddex-delivery-logs-id.md): Get delivery logs for a message
- [Get delivery status for a message](https://apidocs.royalti.io/api-reference/ddex/get-ddex-delivery-status-id.md): Get delivery status for a message
- [List DDEX messages](https://apidocs.royalti.io/api-reference/ddex/get-ddex-messages.md): List DDEX messages
- [Get a DDEX message](https://apidocs.royalti.io/api-reference/ddex/get-ddex-messages-id.md): Get a DDEX message
- [Get a signed download URL for a message](https://apidocs.royalti.io/api-reference/ddex/get-ddex-messages-id-download.md): Get a signed download URL for a message
- [Get DDEX monitoring dashboard for the current tenant](https://apidocs.royalti.io/api-reference/ddex/get-ddex-monitoring-dashboard.md): Get DDEX monitoring dashboard for the current tenant
- [List global DDEX providers](https://apidocs.royalti.io/api-reference/ddex/get-ddex-providers.md): List global DDEX providers
- [Get provider details](https://apidocs.royalti.io/api-reference/ddex/get-ddex-providers-id.md): Get provider details
- [Get provider statistics for tenant](https://apidocs.royalti.io/api-reference/ddex/get-ddex-providers-id-stats.md): Get provider statistics for tenant
- [List DDEX queue jobs (tenant-scoped)](https://apidocs.royalti.io/api-reference/ddex/get-ddex-queue-jobs.md): List DDEX queue jobs (tenant-scoped)
- [Get a single DDEX queue job (tenant-scoped)](https://apidocs.royalti.io/api-reference/ddex/get-ddex-queue-jobs-id.md): Get a single DDEX queue job (tenant-scoped)
- [Get logs for a DDEX queue job (tenant-scoped)](https://apidocs.royalti.io/api-reference/ddex/get-ddex-queue-jobs-id-logs.md): Get logs for a DDEX queue job (tenant-scoped)
- [List tenant provider configurations](https://apidocs.royalti.io/api-reference/ddex/get-ddex-tenant-providers.md): List tenant provider configurations
- [Queue delivery for multiple messages](https://apidocs.royalti.io/api-reference/ddex/post-ddex-delivery-deliver-batch.md): Queue delivery for multiple messages
- [Queue message delivery](https://apidocs.royalti.io/api-reference/ddex/post-ddex-delivery-deliver-id.md): Queue message delivery
- [Retry delivery for a failed message](https://apidocs.royalti.io/api-reference/ddex/post-ddex-delivery-retry-id.md): Retry delivery for a failed message
- [Test connection to all configured DDEX providers](https://apidocs.royalti.io/api-reference/ddex/post-ddex-delivery-test-all-connections.md): Test connection to all configured DDEX providers
- [Test connection to a DDEX provider](https://apidocs.royalti.io/api-reference/ddex/post-ddex-delivery-test-connection.md): Test connection to a DDEX provider
- [Generate ERN for a Product](https://apidocs.royalti.io/api-reference/ddex/post-ddex-ern-generate.md): Starts an ERN generation flow for a single product and provider.
- [Generate ERN in batch](https://apidocs.royalti.io/api-reference/ddex/post-ddex-ern-generate-batch.md): Starts a batch ERN generation flow for multiple products with a provider.
- [Queue MEAD generation for a Product](https://apidocs.royalti.io/api-reference/ddex/post-ddex-mead-generate.md): Queue MEAD generation for a Product
- [Validate a DDEX message](https://apidocs.royalti.io/api-reference/ddex/post-ddex-messages-id-validate.md): Validate a DDEX message
- [Create tenant provider configuration](https://apidocs.royalti.io/api-reference/ddex/post-ddex-tenant-providers.md): Create a new DDEX provider configuration for the current tenant.
- [Update MEAD metadata for an entity](https://apidocs.royalti.io/api-reference/ddex/put-ddex-mead-id.md): Update MEAD metadata for a specific entity (asset, product, artist, or label) identified by `entityId`.
- [Update tenant provider configuration](https://apidocs.royalti.io/api-reference/ddex/put-ddex-tenant-providers-id.md): Update an existing DDEX provider configuration.
- [Delete Default Setting (Tenant/Catalog Level)](https://apidocs.royalti.io/api-reference/default-settings/delete-defaultsettings-id-id.md): **DELETE /defaultsettings/{entityType}/{settingId}**
- [Delete Default Setting (Entity-Specific)](https://apidocs.royalti.io/api-reference/default-settings/delete-defaultsettings-id-id-id.md): **DELETE /defaultsettings/{entityType}/{entityId}/{settingId}**
- [Delete Template](https://apidocs.royalti.io/api-reference/default-settings/delete-defaultsettings-templates-id.md): **DELETE /defaultsettings/templates/{templateId}**
- [Get Default Settings (Tenant/Catalog Level)](https://apidocs.royalti.io/api-reference/default-settings/get-defaultsettings-id.md): **GET /defaultsettings/{entityType}**
- [Get Default Settings (Entity-Specific)](https://apidocs.royalti.io/api-reference/default-settings/get-defaultsettings-id-id.md): **GET /defaultsettings/{entityType}/{entityId}**
- [Get Default Setting by ID](https://apidocs.royalti.io/api-reference/default-settings/get-defaultsettings-settings-id.md): **GET /defaultsettings/settings/{settingId}**
- [Get Templates](https://apidocs.royalti.io/api-reference/default-settings/get-defaultsettings-templates.md): **GET /defaultsettings/templates**
- [Get Popular Templates](https://apidocs.royalti.io/api-reference/default-settings/get-defaultsettings-templates-popular.md): **GET /defaultsettings/templates/popular**
- [Clone Default Settings](https://apidocs.royalti.io/api-reference/default-settings/post-defaultsettings-clone.md): **POST /defaultsettings/clone**
- [Create Default Setting (Tenant/Catalog Level)](https://apidocs.royalti.io/api-reference/default-settings/post-defaultsettings-id.md): **POST /defaultsettings/{entityType}**
- [Create Default Setting (Entity-Specific)](https://apidocs.royalti.io/api-reference/default-settings/post-defaultsettings-id-id.md): **POST /defaultsettings/{entityType}/{entityId}**
- [Preview Asset Defaults](https://apidocs.royalti.io/api-reference/default-settings/post-defaultsettings-preview-asset.md): **POST /defaultsettings/preview/asset**
- [Preview Product Defaults](https://apidocs.royalti.io/api-reference/default-settings/post-defaultsettings-preview-product.md): **POST /defaultsettings/preview/product**
- [Preview Release Defaults](https://apidocs.royalti.io/api-reference/default-settings/post-defaultsettings-preview-release.md): **POST /defaultsettings/preview/release**
- [Preview Resolved Defaults](https://apidocs.royalti.io/api-reference/default-settings/post-defaultsettings-preview-resolve.md): **POST /defaultsettings/preview/resolve**
- [Create Template](https://apidocs.royalti.io/api-reference/default-settings/post-defaultsettings-templates.md): **POST /defaultsettings/templates**
- [Apply Template](https://apidocs.royalti.io/api-reference/default-settings/post-defaultsettings-templates-id-apply.md): **POST /defaultsettings/templates/{templateId}/apply**
- [Update Default Setting (Tenant/Catalog Level)](https://apidocs.royalti.io/api-reference/default-settings/put-defaultsettings-id-id.md): **PUT /defaultsettings/{entityType}/{settingId}**
- [Update Default Setting (Entity-Specific)](https://apidocs.royalti.io/api-reference/default-settings/put-defaultsettings-id-id-id.md): **PUT /defaultsettings/{entityType}/{entityId}/{settingId}**
- [Update Template](https://apidocs.royalti.io/api-reference/default-settings/put-defaultsettings-templates-id.md): **PUT /defaultsettings/templates/{templateId}**
- [Get Expenses](https://apidocs.royalti.io/api-reference/expense/get-expense.md): **Get Expenses**
- [Get Expense](https://apidocs.royalti.io/api-reference/expense/get-expense-id.md): **Get Expense**
- [Create Expense](https://apidocs.royalti.io/api-reference/expense/post-expense.md): **Create Expense**
- [Create Bulk Expenses](https://apidocs.royalti.io/api-reference/expense/post-expense-bulk.md): **Create Bulk Expenses**
- [Delete Bulk Expenses](https://apidocs.royalti.io/api-reference/expense/post-expense-bulk-delete.md): **Delete Bulk Expenses**
- [Update Expense](https://apidocs.royalti.io/api-reference/expense/put-expense-id.md): **Update Expense**
- [Delete royalty file and associated BigQuery table](https://apidocs.royalti.io/api-reference/file/delete-file-royalty-id.md): Permanently deletes a royalty file, its BigQuery table, and Cloud Storage file.
- [Get File Upload Info](https://apidocs.royalti.io/api-reference/file/get-file.md): Retrieves information about uploaded files with various filtering and pagination options.
- [Check File Decompression Status](https://apidocs.royalti.io/api-reference/file/get-file-id.md): Checks the decompression/processing status of a file, particularly for files
- [Confirm File Detection](https://apidocs.royalti.io/api-reference/file/post-file-confirm-detection-id.md): Confirms the detection/validation of a file after upload. This endpoint processes
- [Confirm Upload Completion](https://apidocs.royalti.io/api-reference/file/post-file-confirm-upload-completion.md): Confirms that a file upload has completed successfully and triggers processing.
- [Generate Royalty Report File](https://apidocs.royalti.io/api-reference/file/post-file-createroyalty.md): Generates a royalty report file based on BigQuery data and saves it to storage.
- [Get Google Drive Signed URL](https://apidocs.royalti.io/api-reference/file/post-file-get-drive-signed-url.md): Generates a signed URL for uploading a file from Google Drive.
- [Resend Pending Files](https://apidocs.royalti.io/api-reference/file/post-file-resend-pending-files.md): Resends all pending files for a given royalty source for processing.
- [Upload Royalty File](https://apidocs.royalti.io/api-reference/file/post-file-royalty.md): Uploads a royalty file and associated metadata for processing.
- [Upload File from Google Drive](https://apidocs.royalti.io/api-reference/file/post-file-upload-from-drive.md): Uploads a file from Google Drive to storage for royalty processing.
- [Get File Upload URL](https://apidocs.royalti.io/api-reference/file/post-file-upload-url.md): Generates a pre-signed URL for uploading a file to the server with optional auto-detection.
- [Process/Decompress Royalty File](https://apidocs.royalti.io/api-reference/file/put-file-royalty-decompress-id-id.md): Decompresses and processes a previously uploaded royalty file by tenant and file ID.
- [Delete Workspace Integration](https://apidocs.royalti.io/api-reference/integration/delete-integrations-workspace.md): Deletes a workspace integration by ID.
- [Get All Integrations](https://apidocs.royalti.io/api-reference/integration/get-integrations-all.md): Retrieve a list of all available integrations for the workspace.
- [Get Integration Info](https://apidocs.royalti.io/api-reference/integration/get-integrations-info.md): Retrieve general information about integration capabilities and configuration.
- [List Workspace Integrations](https://apidocs.royalti.io/api-reference/integration/get-integrations-workspace.md): Retrieves a list of integrations for the workspace.
- [Get Workspace Integration Info](https://apidocs.royalti.io/api-reference/integration/get-integrations-workspace-info.md): Retrieves information about the workspace integration.
- [Create Workspace Integration](https://apidocs.royalti.io/api-reference/integration/post-integrations-workspace.md): Creates a new workspace integration.
- [Update Workspace Integration](https://apidocs.royalti.io/api-reference/integration/put-integrations-workspace.md): Updates an existing workspace integration.
- [Delete Label](https://apidocs.royalti.io/api-reference/label/delete-labels-id.md): Delete Label
- [Remove Label Access](https://apidocs.royalti.io/api-reference/label/delete-labels-id-access-id.md): Remove Label Access
- [Remove Artist from Label](https://apidocs.royalti.io/api-reference/label/delete-labels-id-artists-id.md): Remove Artist from Label
- [Remove Product from Label](https://apidocs.royalti.io/api-reference/label/delete-labels-id-products-id.md): Remove Product from Label
- [Get Label Hierarchy](https://apidocs.royalti.io/api-reference/label/get-labels-hierarchy.md): Returns the hierarchical label structure (imprints/parent-child relationships) for the tenant.
- [Get Label by ID](https://apidocs.royalti.io/api-reference/label/get-labels-id.md): Get Label by ID
- [List Label Access](https://apidocs.royalti.io/api-reference/label/get-labels-id-access.md): List Label Access
- [Get Label Settings](https://apidocs.royalti.io/api-reference/label/get-labels-id-settings.md): Get Label Settings
- [Update Label Access](https://apidocs.royalti.io/api-reference/label/patch-labels-id-access-id.md): Update Label Access
- [Create Label](https://apidocs.royalti.io/api-reference/label/post-labels.md): Creates a new label within the authenticated tenant. All operations are tenant-scoped.
- [Add Label Access](https://apidocs.royalti.io/api-reference/label/post-labels-id-access.md): Add Label Access
- [Add Artist to Label](https://apidocs.royalti.io/api-reference/label/post-labels-id-artists.md): Add Artist to Label
- [Add Product to Label](https://apidocs.royalti.io/api-reference/label/post-labels-id-products.md): Add Product to Label
- [Update Label](https://apidocs.royalti.io/api-reference/label/put-labels-id.md): Update Label
- [Update Label Settings](https://apidocs.royalti.io/api-reference/label/put-labels-id-settings.md): Update Label Settings
- [Get Notifications](https://apidocs.royalti.io/api-reference/notifications/get-notifications.md): Retrieves a list of notifications for the current user.
- [Get Notification Preferences](https://apidocs.royalti.io/api-reference/notifications/get-notifications-preferences.md): Retrieves the notification preferences for the current user.
- [Get Unread Notification Count](https://apidocs.royalti.io/api-reference/notifications/get-notifications-unread-count.md): Retrieves the count of unread notifications for the current user.
- [Mark Notification as Read](https://apidocs.royalti.io/api-reference/notifications/patch-notifications-id-read.md): Marks a specific notification as read for the current user.
- [Mark All Notifications as Read](https://apidocs.royalti.io/api-reference/notifications/patch-notifications-mark-all-read.md): Marks all notifications as read for the current user.
- [Update Notification Preferences](https://apidocs.royalti.io/api-reference/notifications/put-notifications-preferences.md): Updates the notification preferences for the current user.
- [Delete Payment Request](https://apidocs.royalti.io/api-reference/payment-requests/delete-payment-request-id.md): **Delete Payment Request**
- [Get Payment Requests](https://apidocs.royalti.io/api-reference/payment-requests/get-payment-request.md): **Get Payment Requests**
- [Get Payment Request](https://apidocs.royalti.io/api-reference/payment-requests/get-payment-request-id.md): **Get Payment Request**
- [Approve Payment Request](https://apidocs.royalti.io/api-reference/payment-requests/patch-payment-request-id-approve.md): **Approve Payment Request**
- [Decline Payment Request](https://apidocs.royalti.io/api-reference/payment-requests/patch-payment-request-id-decline.md): **Decline Payment Request**
- [New Payment Request](https://apidocs.royalti.io/api-reference/payment-requests/post-payment-request.md): # Create Payment Request
- [Delete Bulk Payment Requests](https://apidocs.royalti.io/api-reference/payment-requests/post-payment-request-bulk-delete.md): **Delete Bulk Payment Requests**
- [Update Payment Request](https://apidocs.royalti.io/api-reference/payment-requests/put-payment-request-id.md): **Update Payment Request**
- [Delete Payment Setting](https://apidocs.royalti.io/api-reference/payment-settings/delete-payment-setting-id.md): **Delete Payment Setting**
- [Get Payment Settings](https://apidocs.royalti.io/api-reference/payment-settings/get-payment-setting.md): **`/payment-setting`**
- [Get Payment Setting](https://apidocs.royalti.io/api-reference/payment-settings/get-payment-setting-id.md): **Get Payment Setting**
- [Create New Payment Setting](https://apidocs.royalti.io/api-reference/payment-settings/post-payment-setting.md): **`/payment-setting/`**
- [Delete Bulk Payment Settings](https://apidocs.royalti.io/api-reference/payment-settings/post-payment-setting-bulk-delete.md): **Delete Bulk Payment Settings**
- [Update Payment Setting](https://apidocs.royalti.io/api-reference/payment-settings/put-payment-setting-id.md): **Update Payment Setting**
- [Delete Payment](https://apidocs.royalti.io/api-reference/payments/delete-payment-id.md): **Delete Payment**
- [Get Payments](https://apidocs.royalti.io/api-reference/payments/get-payment.md): **Get Payments**
- [Get Payment](https://apidocs.royalti.io/api-reference/payments/get-payment-id.md): **Get Payment**
- [Create Payment](https://apidocs.royalti.io/api-reference/payments/post-payment.md): **Create Payment**
- [Create Bulk Payments](https://apidocs.royalti.io/api-reference/payments/post-payment-bulk.md): **Create Bulk Payments**
- [Delete Bulk Payments](https://apidocs.royalti.io/api-reference/payments/post-payment-bulk-delete.md): **Delete Bulk Payments**
- [Update Payment](https://apidocs.royalti.io/api-reference/payments/put-payment-id.md): **Update Payment**
- [Delete Product](https://apidocs.royalti.io/api-reference/product/delete-product-id.md): **/product/{id}**
- [Delete Product Media](https://apidocs.royalti.io/api-reference/product/delete-product-id-media-id.md): **/product/{id}/media/{mediaName}**
- [Get Products](https://apidocs.royalti.io/api-reference/product/get-product.md): **/product/**
- [Get Product](https://apidocs.royalti.io/api-reference/product/get-product-id.md): **/product/{id}**
- [Get Product Stats](https://apidocs.royalti.io/api-reference/product/get-product-id-stats.md): **/product/{id}/stats**
- [Create Product](https://apidocs.royalti.io/api-reference/product/post-product.md): ### POST /product/
- [Create Bulk Products](https://apidocs.royalti.io/api-reference/product/post-product-bulk.md): **/product/bulk**
- [Delete Bulk Products](https://apidocs.royalti.io/api-reference/product/post-product-bulk-delete.md): **/product/bulk/delete**
- [Delete Splits from Bulk Products](https://apidocs.royalti.io/api-reference/product/post-product-bulk-deletesplit.md): **/product/bulk/deletesplit**
- [Download Products CSV](https://apidocs.royalti.io/api-reference/product/post-product-download-csv.md): **/product/download/csv**
- [Download Product Metadata](https://apidocs.royalti.io/api-reference/product/post-product-download-metadata.md): **/product/download/metadata**
- [Upload Product Media](https://apidocs.royalti.io/api-reference/product/post-product-id-media.md): **/product/{id}/media**
- [Set Default Split for Bulk Products](https://apidocs.royalti.io/api-reference/product/put-product-bulk-defaultsplit.md): **/product/bulk/defaultsplit**
- [Update Bulk Product Splits](https://apidocs.royalti.io/api-reference/product/put-product-bulksplits.md): **/product/bulksplits**
- [Update Product](https://apidocs.royalti.io/api-reference/product/put-product-id.md): **/product/{id}**
- [Update Product Artists](https://apidocs.royalti.io/api-reference/product/put-product-id-artists.md): **/product/{id}/artists**
- [Update Product Assets](https://apidocs.royalti.io/api-reference/product/put-product-id-assets.md): **/product/{id}/assets**
- [Set Default Split for Product from Artist](https://apidocs.royalti.io/api-reference/product/put-product-id-setdefaultsplit.md): **/product/{id}/setdefaultsplit**
- [Delete Release](https://apidocs.royalti.io/api-reference/release/delete-releases-id.md): ### DELETE /releases/{id}
- [Delete Release Media](https://apidocs.royalti.io/api-reference/release/delete-releases-id-media-id.md): ### DELETE /releases/{id}/media/{mediaId}
- [Delete a track (release asset)](https://apidocs.royalti.io/api-reference/release/delete-releases-id-tracks-id.md): Deletes an existing track from the specified release. Only allowed for releases in 'draft' or 'rejected' status.
- [Delete Track Media](https://apidocs.royalti.io/api-reference/release/delete-releases-id-tracks-id-media-id.md): ### DELETE /releases/{id}/tracks/{trackId}/media/{mediaId}
- [Get Releases](https://apidocs.royalti.io/api-reference/release/get-releases.md): ### GET /releases
- [Get Release by ID](https://apidocs.royalti.io/api-reference/release/get-releases-id.md): ### GET /releases/{id}
- [Get Release Media](https://apidocs.royalti.io/api-reference/release/get-releases-id-media.md): ### GET /releases/{id}/media
- [Get Track Media](https://apidocs.royalti.io/api-reference/release/get-releases-id-tracks-id-media.md): ### GET /releases/{id}/tracks/{trackId}/media
- [Get Release Statistics](https://apidocs.royalti.io/api-reference/release/get-releases-stats.md): ### GET /releases/stats
- [Create Release](https://apidocs.royalti.io/api-reference/release/post-releases.md): ### POST /releases
- [Add Feedback to Release](https://apidocs.royalti.io/api-reference/release/post-releases-id-feedback.md): ### POST /releases/{id}/feedback
- [Upload Media Files to Release](https://apidocs.royalti.io/api-reference/release/post-releases-id-media-files.md): ### POST /releases/{id}/media/files
- [Submit Media Links to Release](https://apidocs.royalti.io/api-reference/release/post-releases-id-media-links.md): ### POST /releases/{id}/media/links
- [Revert Release Status (Admin Only)](https://apidocs.royalti.io/api-reference/release/post-releases-id-revert-status.md): ### POST /releases/{id}/revert-status
- [Review Release (Admin Only)](https://apidocs.royalti.io/api-reference/release/post-releases-id-review.md): ### POST /releases/{id}/review
- [Submit Release for Review](https://apidocs.royalti.io/api-reference/release/post-releases-id-submit.md): ### POST /releases/{id}/submit
- [Create a new track (release asset)](https://apidocs.royalti.io/api-reference/release/post-releases-id-tracks.md): Adds a new track to the specified release. Only allowed for releases in 'draft' or 'rejected' status.
- [Upload Media File to Track](https://apidocs.royalti.io/api-reference/release/post-releases-id-tracks-id-media-file.md): ### POST /releases/{id}/tracks/{trackId}/media/file
- [Submit Media Link to Track](https://apidocs.royalti.io/api-reference/release/post-releases-id-tracks-id-media-link.md): ### POST /releases/{id}/tracks/{trackId}/media/link
- [Link Existing Asset to Release](https://apidocs.royalti.io/api-reference/release/post-releases-id-tracks-link-asset.md): ### POST /releases/{id}/tracks/link-asset
- [Reorder Release Tracks](https://apidocs.royalti.io/api-reference/release/post-releases-id-tracks-reorder.md): ### POST /releases/{id}/tracks/reorder
- [Update Release](https://apidocs.royalti.io/api-reference/release/put-releases-id.md): ### PUT /releases/{id}
- [Update a track (release asset)](https://apidocs.royalti.io/api-reference/release/put-releases-id-tracks-id.md): Updates an existing track in the specified release. Only allowed for releases in 'draft' or 'rejected' status.
- [Delete Revenue](https://apidocs.royalti.io/api-reference/revenue/delete-revenue-id.md): **Delete Revenue**
- [Get Revenues](https://apidocs.royalti.io/api-reference/revenue/get-revenue.md): **Get Revenues**
- [Get Revenue](https://apidocs.royalti.io/api-reference/revenue/get-revenue-id.md): **Get Revenue**
- [Create Revenue](https://apidocs.royalti.io/api-reference/revenue/post-revenue.md): **Create Revenue**
- [Create Bulk Revenues](https://apidocs.royalti.io/api-reference/revenue/post-revenue-bulk.md): **Create Bulk Revenues**
- [Delete Bulk Revenues](https://apidocs.royalti.io/api-reference/revenue/post-revenue-bulk-delete.md): **Delete Bulk Revenues**
- [Update Revenue](https://apidocs.royalti.io/api-reference/revenue/put-revenue-id.md): **Update Revenue**
- [Get Royalties Summary](https://apidocs.royalti.io/api-reference/royalties/get-royalty.md): **Get a summary of Royalties**
- [Get Royalties grouped by month (Accounting period)](https://apidocs.royalti.io/api-reference/royalties/get-royalty-accountingperiod.md): **Get Royalties grouped by month (Accounting period)**
- [Get Royalties grouped by aggregator](https://apidocs.royalti.io/api-reference/royalties/get-royalty-aggregator.md): **Get Royalties grouped by aggregator**
- [Get Royalties grouped by artist](https://apidocs.royalti.io/api-reference/royalties/get-royalty-artist.md): **Get Royalties grouped by artist**
- [Get Royalties grouped by asset](https://apidocs.royalti.io/api-reference/royalties/get-royalty-asset.md): **Get Royalties grouped by asset**
- [Get Royalties grouped by country](https://apidocs.royalti.io/api-reference/royalties/get-royalty-country.md): **Get Royalties grouped by country**
- [Get Royalties grouped by DSP (Providers)](https://apidocs.royalti.io/api-reference/royalties/get-royalty-dsp.md): **Get Royalties grouped by DSP (Providers)**
- [Get Royalties grouped by month (Sale period)](https://apidocs.royalti.io/api-reference/royalties/get-royalty-month.md): **Get Royalties grouped by month (Sale period)**
- [Get Royalties grouped by product](https://apidocs.royalti.io/api-reference/royalties/get-royalty-product.md): **Get Royalties grouped by product**
- [Get Royalties grouped by sale type](https://apidocs.royalti.io/api-reference/royalties/get-royalty-saletype.md): **Get Royalties grouped by sale type**
- [Get Royalties grouped by table source](https://apidocs.royalti.io/api-reference/royalties/get-royalty-tables.md): **Get Royalties grouped by table source**
- [Delete Royalty Source (Admin)](https://apidocs.royalti.io/api-reference/sources/delete-sources-admin-id.md): Deletes a royalty source by its ID.
- [List Tenant Sources](https://apidocs.royalti.io/api-reference/sources/get-sources.md): Retrieves a paginated list of all sources associated with the current tenant.
- [List All Royalty Sources (Admin)](https://apidocs.royalti.io/api-reference/sources/get-sources-admin.md): Retrieves a paginated list of all royalty sources in the system.
- [Get Royalty Source by ID (Admin)](https://apidocs.royalti.io/api-reference/sources/get-sources-admin-id.md): Retrieves a royalty source by its ID.
- [Get Tenant Source by RoyaltySource ID](https://apidocs.royalti.io/api-reference/sources/get-sources-id.md): Retrieves a tenant source association by the RoyaltySource ID.
- [Add Tenant Source](https://apidocs.royalti.io/api-reference/sources/post-sources.md): Adds a source association for the current tenant. Supports two modes:
- [Create Royalty Source (Admin)](https://apidocs.royalti.io/api-reference/sources/post-sources-admin.md): Creates a new royalty source record available globally.
- [Activate Tenant Source by RoyaltySource ID](https://apidocs.royalti.io/api-reference/sources/post-sources-id-activate.md): Activates a tenant source association by the RoyaltySource ID.
- [Deactivate Tenant Source by RoyaltySource ID](https://apidocs.royalti.io/api-reference/sources/post-sources-id-deactivate.md): Deactivates a tenant source association by the RoyaltySource ID.
- [Update Royalty Source (Admin)](https://apidocs.royalti.io/api-reference/sources/put-sources-admin-id.md): Updates a royalty source by its ID.
- [Update Tenant Source by RoyaltySource ID](https://apidocs.royalti.io/api-reference/sources/put-sources-id.md): Updates a tenant source association by the RoyaltySource ID.
- [Bulk delete catalog splits](https://apidocs.royalti.io/api-reference/splits/delete-split-bulk-catalog-splits.md): **Bulk Delete Catalog Splits**
- [Delete Split](https://apidocs.royalti.io/api-reference/splits/delete-split-id.md): **/split/{splitId}**
- [Get splits](https://apidocs.royalti.io/api-reference/splits/get-split.md): **Get All Revenue Split Configurations**
- [Get Split](https://apidocs.royalti.io/api-reference/splits/get-split-id.md): **/split/{splitId}**
- [Create split](https://apidocs.royalti.io/api-reference/splits/post-split.md): **Create Revenue Split**
- [Bulk delete Splits](https://apidocs.royalti.io/api-reference/splits/post-split-bulk-delete.md): **Bulk Delete Revenue Split Configurations**
- [Create Default Splits](https://apidocs.royalti.io/api-reference/splits/post-split-default.md): **/split/default**
- [Match Splits](https://apidocs.royalti.io/api-reference/splits/post-split-match.md): **/split/match**
- [Update Split](https://apidocs.royalti.io/api-reference/splits/put-split-id.md): **/split/{splitId}**
- [Delete User](https://apidocs.royalti.io/api-reference/user/delete-user-id.md): **/user/{userId}**
- [Remove User Email](https://apidocs.royalti.io/api-reference/user/delete-user-id-email-id.md): **/user/{id}/email/{email}**
- [Get Users](https://apidocs.royalti.io/api-reference/user/get-user.md): **/user/** - Enhanced with Fast Accounting Data
- [Get User](https://apidocs.royalti.io/api-reference/user/get-user-id.md): **/user/{userId}**
- [Get User Artists](https://apidocs.royalti.io/api-reference/user/get-user-id-artists.md): **/user/{userId}/artists**
- [Get User Assets](https://apidocs.royalti.io/api-reference/user/get-user-id-assets.md): **/user/{userId}/assets**
- [Get User Monthly Stats](https://apidocs.royalti.io/api-reference/user/get-user-id-monthly.md): **/user/{userId}/monthly**
- [Get User Products](https://apidocs.royalti.io/api-reference/user/get-user-id-products.md): **/user/{userId}/products**
- [Get User Stats](https://apidocs.royalti.io/api-reference/user/get-user-id-stats.md): **/user/{userId}/stats**
- [List workspace invites](https://apidocs.royalti.io/api-reference/user/get-user-invites.md): Returns recent invitations for the active workspace. Results include pending, joined, and cancelled invitations. When an invitation is cancelled the associated activation link is immediately revoked, so cancelled records are informational only.
- [Update User](https://apidocs.royalti.io/api-reference/user/patch-user-id.md): **/user/{userId}**
- [Create User](https://apidocs.royalti.io/api-reference/user/post-user.md): **/user/**
- [Create Bulk User](https://apidocs.royalti.io/api-reference/user/post-user-bulk.md): **/user/bulk**
- [Bulk Delete Users](https://apidocs.royalti.io/api-reference/user/post-user-bulk-delete.md): **/user/bulk/delete**
- [Create Bulk Entity](https://apidocs.royalti.io/api-reference/user/post-user-bulk-entity.md): **/user/bulk/entity**
- [Download User Data](https://apidocs.royalti.io/api-reference/user/post-user-download-csv.md): **/user/download/csv**
- [Cancel workspace invite](https://apidocs.royalti.io/api-reference/user/post-user-invites-id-cancel.md): Cancels a pending invitation. The invite status changes to `cancelled` and any activation codes generated for the invitee are purged, preventing future use of the old invite link.
- [Resend workspace invite](https://apidocs.royalti.io/api-reference/user/post-user-invites-id-resend.md): Sends a fresh activation email for an invitation that is still in the `invited` state. The new email includes a newly generated activation code and preserves any updated custom message.
- [Add User to Tenant](https://apidocs.royalti.io/api-reference/user/put-user-id-aut.md): **/user/{userId}/aut**
- [Delete VertoFx Integration](https://apidocs.royalti.io/api-reference/vertofx/delete-integrations-vertofx.md): Delete VertoFX Integration
- [Delete VertoFx Beneficiary](https://apidocs.royalti.io/api-reference/vertofx/delete-integrations-vertofx-beneficiaries-id.md): Deletes a VertoFx beneficiary by ID.
- [Unlink Verto Beneficiary From User](https://apidocs.royalti.io/api-reference/vertofx/delete-integrations-vertofx-beneficiaries-id-unlink.md): Unlink Verto Beneficiary From User
- [Get All VertoFx Integrations](https://apidocs.royalti.io/api-reference/vertofx/get-integrations-vertofx-all.md): Get All VertoFx Integrations
- [Get Beneficiaries List](https://apidocs.royalti.io/api-reference/vertofx/get-integrations-vertofx-beneficiaries.md): Get VertoFX Beneficiaries
- [Get Beneficiary Details](https://apidocs.royalti.io/api-reference/vertofx/get-integrations-vertofx-beneficiaries-id.md): Get VertoFX Beneficiary Details
- [Get VertoFx Integration Info](https://apidocs.royalti.io/api-reference/vertofx/get-integrations-vertofx-info.md): Get VertoFX Integration Info
- [Get VertoFx Payment Requests](https://apidocs.royalti.io/api-reference/vertofx/get-integrations-vertofx-payment-requests.md): Get VertoFX Payment Requests
- [Get VertoFx Payment Request Details](https://apidocs.royalti.io/api-reference/vertofx/get-integrations-vertofx-payment-requests-id.md): Get VertoFX Payment Request Details
- [Get VertoFx Purpose Codes](https://apidocs.royalti.io/api-reference/vertofx/get-integrations-vertofx-purpose-codes.md): Retrieves the list of available purpose codes from VertoFx for cross-border payments.
- [Get Verto Wallets](https://apidocs.royalti.io/api-reference/vertofx/get-integrations-vertofx-wallets.md): Get VertoFX Wallets
- [Add VertoFx Integrations](https://apidocs.royalti.io/api-reference/vertofx/post-integrations-vertofx.md): Create VertoFX Integration
- [Create Beneficiary](https://apidocs.royalti.io/api-reference/vertofx/post-integrations-vertofx-beneficiaries.md): Create VertoFX Beneficiary
- [Link Verto Beneficiary to User](https://apidocs.royalti.io/api-reference/vertofx/post-integrations-vertofx-beneficiaries-link.md): Link Verto Beneficiary to User
- [Create VertoFx Payment Request](https://apidocs.royalti.io/api-reference/vertofx/post-integrations-vertofx-payment-requests.md): Create VertoFX Payment Request
- [Create VertoFx Payment Request (v2)](https://apidocs.royalti.io/api-reference/vertofx/post-integrations-vertofx-payment-requests-v2.md): Creates a new payment request in VertoFx (v2 API).
- [Update VertoFx Integration](https://apidocs.royalti.io/api-reference/vertofx/put-integrations-vertofx.md): Update VertoFX Integration
- [Update VertoFx Beneficiary](https://apidocs.royalti.io/api-reference/vertofx/put-integrations-vertofx-beneficiaries-id.md): Updates the details of a VertoFx beneficiary by ID.
- [Download status update webhook](https://apidocs.royalti.io/api-reference/webhooks/post-webhook-download-status-update-webhook.md): Receives status updates for download preparation operations from Google Cloud Functions.
- [Royalty file status update webhook](https://apidocs.royalti.io/api-reference/webhooks/post-webhook-royalty-file-update-webhook.md): Receives status updates for royalty file processing from Google Cloud Functions or external processing systems.
- [VertoFX payment status webhook](https://apidocs.royalti.io/api-reference/webhooks/post-webhook-verto-payment-outward-webhook.md): Receives payment status updates from VertoFX payment processor.
- [API Changelog](https://apidocs.royalti.io/changelog/changelog.md): Track changes and updates to the Royalti.io API
- [Advanced Metadata (MEAD)](https://apidocs.royalti.io/guides/advanced-product-metadata.md): Guide to using MEAD enhancement fields for products and assets for rich metadata delivery to DSPs
- [DDEX Integration Guide](https://apidocs.royalti.io/guides/ddex-integration.md): Generate and deliver DDEX messages for digital music distribution to DSPs
- [Default Settings](https://apidocs.royalti.io/guides/default-settings.md): Learn how to use the Default Settings system to streamline catalog management with hierarchical configuration inheritance
- [Financial Data & Management](https://apidocs.royalti.io/guides/financial-data-management.md): View earnings, track expenses and revenue, manage accounting, and reconcile financial data in Royalti.io
- [FUGA Integration Guide](https://apidocs.royalti.io/guides/fuga-integration.md): Deliver music catalog to DSPs via FUGA's CSV/FTP distribution platform
- [Integrated Workflows](https://apidocs.royalti.io/guides/integrated-workflows.md): Complete end-to-end workflows combining user management, splits, accounting, and payments for common scenarios
- [Notification System Guide](https://apidocs.royalti.io/guides/notifications.md): Complete guide to managing notifications and notification preferences in Royalti.io - receive updates through multiple channels
- [Payment Processing Guide](https://apidocs.royalti.io/guides/payment-processing.md): Create payment requests, process royalty payments, and manage payment workflows for collaborators
- [Real-Time Events Guide](https://apidocs.royalti.io/guides/real-time-events.md): Connect via WebSocket to receive instant file processing status updates without polling
- [Release Management Guide](https://apidocs.royalti.io/guides/release-management.md): Create, manage, and distribute music releases with automated product and asset generation
- [File Detection & Confirmation](https://apidocs.royalti.io/guides/royalty-detection-confirmation.md): Automatically detect royalty sources with confidence scoring and smart file recognition
- [Royalty Management Guide](https://apidocs.royalti.io/guides/royalty-management.md): Upload, process, and analyze royalty data from multiple streaming platforms and distributors
- [Splits & Revenue Distribution Guide](https://apidocs.royalti.io/guides/splits-management.md): Complete guide to creating, managing, and automating revenue splits for assets and products
- [User Management & Collaboration](https://apidocs.royalti.io/guides/user-management.md): Create, invite, and manage users with role-based access control
- [Webhook Integration Guide](https://apidocs.royalti.io/guides/webhook-integration.md): Complete guide to implementing webhooks with Royalti.io - both receiving notifications from Royalti and sending updates to Royalti
- [Authentication Guide](https://apidocs.royalti.io/introduction/authentication.md): Complete guide to authenticating with the Royalti.io API
- [Welcome to Royalti.io API](https://apidocs.royalti.io/introduction/index.md): Comprehensive API for music royalty management, payment processing, and content distribution
- [Quick Start Guide](https://apidocs.royalti.io/introduction/quickstart.md): Get started with the Royalti.io API in just a few minutes

## OpenAPI Specs

- [openapi](https://apidocs.royalti.io/openapi.json)
- [openapi-backup](https://apidocs.royalti.io/openapi-backup.json)
- [openapi-clean](https://apidocs.royalti.io/openapi-clean.json)
- [postman-openapi](https://apidocs.royalti.io/postman-openapi.json)