Skip to main content
GET
/
split
Get splits
curl --request GET \
  --url https://api.royalti.io/split/ \
  --header 'Authorization: Bearer <token>'
{
  "totalItems": 55,
  "Splits": [
    {
      "id": "a8787d14-1149-4b10-9e29-7ef054de8c3f",
      "ProductId": null,
      "AssetId": "0518ea7b-222b-4851-8232-9ec909730fab",
      "name": "USqwEAB7654321: Your Song",
      "type": null,
      "contract": null,
      "ContractId": null,
      "conditions": null,
      "SplitShares": [
        {
          "UserId": "91f1d1bd-ef25-4990-bd4f-aeee696c73a9",
          "Share": 40,
          "User": {
            "firstName": "taylor slow",
            "lastName": "staff"
          }
        },
        {
          "UserId": "9ea08acc-e135-4bd9-b159-48339ff65061",
          "Share": 30,
          "User": {
            "firstName": "John",
            "lastName": "Doe"
          }
        }
      ]
    }
  ]
}
This endpoint requires authentication. Include your Bearer token in the Authorization header.

​
Description

Get All Revenue Split Configurations The Get All Revenue Split Configurations endpoint allows you to retrieve a list of revenue split configurations based on specified filters and pagination. Method:
GET Query Parameters:
ParameterTypeDescription
pagenumber(Optional) The page number for pagination. Default is 1
sizenumber(Optional) The number of items per page. Default is 10
includestring(Optional) Specify ‘count’ to include the total count of items
assetstring(Optional) Filter by asset UUID
productstring(Optional) Filter by product UUID
typestring(Optional) Filter by revenue split type
userstring(Optional) Filter by user UUID
qstring(Optional) Search query
sortstring(Optional) Field to sort by
orderstring(Optional) Sort order (asc/desc)

​
Code Examples

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

​
page
integer
default:1

The page number for pagination

​
size
integer
default:10

The number of items per page

​
include
string

Specify 'count' to include the total count of items

​
asset
string<uuid>

Filter by asset UUID

​
product
string<uuid>

Filter by product UUID

​
type
string

Filter by revenue split type

​
user
string<uuid>

Filter by user UUID

​
q
string

Search query

​
sort
string

Field to sort by

​
order
enum<string>

Sort order (asc/desc)

Available options:
asc,
desc
​
includeCoverage
boolean
default:false

Include temporal coverage analysis for splits with date ranges

Response

Successfully retrieved splits

​
totalItems
integer

Total number of split configurations

​
Splits
object[]