> ## Documentation Index
> Fetch the complete documentation index at: https://apidocs.royalti.io/llms.txt
> Use this file to discover all available pages before exploring further.
# Get Split
> **/split/{splitId}**
This endpoint requires authentication. Include your Bearer token in the Authorization header.
## Description
**/split/{splitId}**
**Description:**\
The `/split/{splitId}` endpoint retrieves the details of a specific split identified by their unique splitId.
**Method:**\
`GET`
## Code Examples
```javascript Node.js theme={null}
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);
```
```python Python theme={null}
import requests
response = requests.get(
'https://api.royalti.io/split/example-id',
headers={
'Authorization': f'Bearer {token}'
},
)
data = response.json()
print(data)
```
```bash cURL theme={null}
curl -X GET https://api.royalti.io/split/example-id \
-H "Authorization: Bearer YOUR_TOKEN" \
```
## OpenAPI
````yaml get /split/{id}
openapi: 3.0.0
info:
title: Royalti.io API
description: "# Royalti API\r\n\r\nThis is the Royalti music royalty management platform API server.\r\n\r\n## Overview\r\n\r\nThe Royalti API provides comprehensive music royalty management services including:\r\n- Music publishing and writer management\r\n- Royalty processing and analytics\r\n- DDEX integration for music industry standards\r\n- File processing and pattern recognition\r\n- Payment processing and distribution\r\n\r\n## Authentication\r\n\r\nThe API uses JWT-based authentication with multiple protection levels:\r\n- Public endpoints for basic operations\r\n- Protected endpoints requiring valid JWT tokens\r\n- Admin endpoints for administrative functions\r\n\r\n## Features\r\n\r\n- Multi-dimensional royalty analytics\r\n- CWR (Collective Works Registration) support\r\n- DDEX integration for music metadata\r\n- Advanced file processing with pattern recognition\r\n- Real-time data processing with queue system"
version: 2.6.0
contact:
name: Royalti.io Support
email: support@royalti.io
url: https://royalti.io
license:
name: Proprietary
url: https://royalti.io/terms
servers:
- url: https://api.royalti.io
description: Production server
- url: https://api-dev.royalti.io
description: Development server
- url: http://localhost:8084
description: Local development
security:
- bearerAuth: []
tags:
- name: Accounting
description: Accounting and financial transaction operations
- name: DDEX
description: DDEX operations (ERN/MEAD, messages, delivery, providers)
- name: Label
description: Label management operations
- name: Internal Webhooks
description: Internal system webhooks for royalty processing and downloads
- name: Payment Webhooks
description: Payment processor webhook endpoints
- name: Billing Webhooks
description: Stripe billing and subscription webhooks
- name: Infrastructure Webhooks
description: Cloudflare domain and SSL webhooks
- name: Distribution Webhooks
description: Digital distribution platform webhooks (FUGA)
paths:
/split/{id}:
get:
tags:
- Splits
summary: Get Split
description: >-
**/split/{splitId}**
**Description:**
The `/split/{splitId}` endpoint retrieves the details of a specific
split identified by their unique splitId.
**Method:**
`GET`
parameters:
- name: id
in: path
required: true
description: Split ID
schema:
type: string
- name: includeCoverage
in: query
required: false
description: Include temporal coverage analysis for splits with date ranges
schema:
type: boolean
default: false
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/Split'
examples:
basic:
summary: Basic split response
value:
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'
withCoverage:
summary: With temporal coverage analysis (includeCoverage=true)
value:
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 (endDate is exclusive)
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: []
Asset:
id: 2e0d9f94-59eb-4ef8-adc6-9f3ddebf49fc
displayArtist: Artist Name
isrc: USRC17607839
title: Song Title
version: Original Mix
Product: null
coverage:
overlapping: []
adjacent:
predecessor:
id: 7b7e2dd7-7744-4648-8538-786e8d0d5b5a
name: Q4 2024 Publishing Split
type: Publishing
endDate: '2025-01-01'
successor:
id: 9c9f4ff9-9966-4759-9760-897f0f1f7c7b
name: Q2 2025 Publishing Split
type: Publishing
startDate: '2025-04-01'
gaps: []
defaultSplits:
- id: default-split-uuid
name: Default Publishing Split
type: Publishing
summary:
hasOverlaps: false
hasPredecessor: true
hasSuccessor: true
hasGaps: false
isOpenEnded: false
hasDefaultSplit: true
createdAt: '2025-01-01T00:00:00.000Z'
updatedAt: '2025-01-01T00:00:00.000Z'
withGaps:
summary: Split with temporal gaps
value:
id: split-with-gaps-uuid
AssetId: asset-uuid
ProductId: null
type: Publishing
startDate: '2025-06-01'
endDate: '2025-09-01'
name: Summer 2025 Publishing Split
memo: Temporary summer split
SplitShares:
- TenantUserId: user-uuid-1
Share: 100
TenantUser:
firstName: Summer
lastName: Partner
ipi: null
conditions: []
Asset:
id: asset-uuid
displayArtist: Artist Name
isrc: USRC12345678
title: Track Title
version: null
Product: null
coverage:
overlapping: []
adjacent:
predecessor: null
successor: null
gaps:
- type: before
description: No coverage before split start date
startDate: null
endDate: '2025-06-01'
- type: after
description: No coverage after split end date
startDate: '2025-09-01'
endDate: null
defaultSplits: []
summary:
hasOverlaps: false
hasPredecessor: false
hasSuccessor: false
hasGaps: true
isOpenEnded: false
hasDefaultSplit: false
createdAt: '2025-06-01T00:00:00.000Z'
updatedAt: '2025-06-01T00:00:00.000Z'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
security:
- bearerAuth: []
components:
schemas:
Split:
type: object
properties:
id:
type: string
format: uuid
description: The unique identifier of the split configuration
AssetId:
type: string
format: uuid
description: The unique identifier of the asset
ProductId:
type: string
format: uuid
description: The unique identifier of the product
name:
type: string
description: The name or description of the revenue split
type:
type: string
nullable: true
enum:
- ' '
- Publishing
- YouTube
- Live
description: The type of revenue (e.g., Publishing, YouTube, Live)
startDate:
type: string
format: date
nullable: true
description: The start date of the split period (inclusive)
endDate:
type: string
format: date
nullable: true
description: The end date of the split period (exclusive)
SplitShares:
type: array
items:
type: object
properties:
TenantUserId:
type: string
format: uuid
Share:
type: number
TenantUser:
type: object
properties:
firstName:
type: string
lastName:
type: string
ipi:
type: string
nullable: true
conditions:
type: array
items:
$ref: '#/components/schemas/SplitCondition'
contract:
type: string
nullable: true
ContractId:
type: string
format: uuid
nullable: true
memo:
type: string
nullable: true
Asset:
type: object
nullable: true
properties:
id:
type: string
format: uuid
displayArtist:
type: string
isrc:
type: string
title:
type: string
version:
type: string
nullable: true
Product:
type: object
nullable: true
properties:
id:
type: string
format: uuid
displayArtist:
type: string
upc:
type: string
title:
type: string
coverage:
$ref: '#/components/schemas/CoverageInfo'
description: Temporal coverage analysis (included when includeCoverage=true)
createdAt:
type: string
format: date-time
updatedAt:
type: string
format: date-time
Error:
type: object
properties:
success:
type: boolean
example: false
error:
type: object
properties:
code:
type: string
message:
type: string
details:
type: array
items:
type: string
SplitCondition:
type: object
properties:
id:
type: string
format: uuid
description: The unique identifier of the condition
mode:
type: string
enum:
- include
- exclude
description: Whether to include or exclude the specified criteria
memo:
type: string
nullable: true
description: Additional notes about the condition
territories:
type: array
items:
type: string
nullable: true
description: Array of ISO country codes
dsps:
type: array
items:
type: string
nullable: true
description: Array of DSP identifiers
usageTypes:
type: array
items:
type: string
nullable: true
description: Array of usage type identifiers
customDimension:
type: string
nullable: true
description: Custom dimension key
customValues:
type: array
items:
type: string
nullable: true
description: Custom dimension values
CoverageInfo:
type: object
properties:
overlapping:
type: array
items:
type: object
properties:
id:
type: string
format: uuid
name:
type: string
type:
type: string
nullable: true
startDate:
type: string
format: date
nullable: true
endDate:
type: string
format: date
nullable: true
description: Splits that overlap with the current split
adjacent:
type: object
properties:
predecessor:
type: object
nullable: true
properties:
id:
type: string
format: uuid
name:
type: string
type:
type: string
nullable: true
endDate:
type: string
format: date
successor:
type: object
nullable: true
properties:
id:
type: string
format: uuid
name:
type: string
type:
type: string
nullable: true
startDate:
type: string
format: date
description: >-
Adjacent splits (predecessor ends when current starts, successor
starts when current ends)
gaps:
type: array
items:
type: object
properties:
type:
type: string
enum:
- before
- after
- between
- infinite
description:
type: string
startDate:
type: string
format: date
nullable: true
endDate:
type: string
format: date
nullable: true
description: Gaps in temporal coverage
defaultSplits:
type: array
items:
type: object
properties:
id:
type: string
format: uuid
name:
type: string
type:
type: string
nullable: true
description: Default splits that provide fallback coverage
summary:
type: object
properties:
hasOverlaps:
type: boolean
hasPredecessor:
type: boolean
hasSuccessor:
type: boolean
hasGaps:
type: boolean
isOpenEnded:
type: boolean
hasDefaultSplit:
type: boolean
description: Summary flags for quick coverage analysis
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
description: >-
JWT Authorization header using the Bearer scheme. Format: "Bearer
{token}"
````