Skip to main content
GET
/
split
/
{id}
Get Split
curl --request GET \
  --url https://api.royalti.io/split/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "8a8f3ee8-8855-4749-9649-897f9e0e6c6b",
  "AssetId": "2e0d9f94-59eb-4ef8-adc6-9f3ddebf49fc",
  "ProductId": null,
  "type": "Publishing",
  "startDate": "2025-01-01",
  "endDate": "2025-04-01",
  "name": "Q1 2025 Publishing Split",
  "contract": null,
  "ContractId": null,
  "memo": "Covers January through March 2025",
  "SplitShares": [
    {
      "TenantUserId": "cf960b5a-37cd-484a-b461-0b191b09bed1",
      "Share": 60,
      "TenantUser": {
        "firstName": "John",
        "lastName": "Doe",
        "ipi": null
      }
    },
    {
      "TenantUserId": "4e39b347-7db0-417d-a5bc-3d8493c9ce19",
      "Share": 40,
      "TenantUser": {
        "firstName": "Jane",
        "lastName": "Smith",
        "ipi": "123456789"
      }
    }
  ],
  "conditions": [
    {
      "id": "condition-uuid",
      "mode": "include",
      "territories": [
        "NG",
        "KE"
      ],
      "dsps": [
        "spotify",
        "apple"
      ],
      "usageTypes": [
        "stream"
      ],
      "memo": "African territories only",
      "customDimension": null,
      "customValues": null
    }
  ],
  "Asset": {
    "id": "2e0d9f94-59eb-4ef8-adc6-9f3ddebf49fc",
    "displayArtist": "Artist Name",
    "isrc": "USRC17607839",
    "title": "Song Title",
    "version": "Original Mix"
  },
  "Product": null,
  "createdAt": "2025-01-01T00:00:00.000Z",
  "updatedAt": "2025-01-01T00:00:00.000Z"
}
This endpoint requires authentication. Include your Bearer token in the Authorization header.

​
Description

/split/ Description:
The /split/{splitId} endpoint retrieves the details of a specific split identified by their unique splitId. Method:
GET

​
Code Examples

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

Path Parameters

​
id
string
required

Split ID

Query Parameters

​
includeCoverage
boolean
default:false

Include temporal coverage analysis for splits with date ranges

Response

Success

​
id
string<uuid>

The unique identifier of the split configuration

​
AssetId
string<uuid>

The unique identifier of the asset

​
ProductId
string<uuid>

The unique identifier of the product

​
name
string

The name or description of the revenue split

​
type
enum<string> | null

The type of revenue (e.g., Publishing, YouTube, Live)

Available options:
,
Publishing,
YouTube,
Live
​
startDate
string<date> | null

The start date of the split period (inclusive)

​
endDate
string<date> | null

The end date of the split period (exclusive)

​
SplitShares
object[]
​
conditions
object[]
​
contract
string | null
​
ContractId
string<uuid> | null
​
memo
string | null
​
Asset
object
​
Product
object
​
coverage
object

Temporal coverage analysis (included when includeCoverage=true)

​
createdAt
string<date-time>
​
updatedAt
string<date-time>