> ## 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 splits

> **Get All Revenue Split Configurations**

<Note>
  This endpoint requires authentication. Include your Bearer token in the Authorization header.
</Note>

## 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:**

| Parameter | Type   | Description                                                    |
| --------- | ------ | -------------------------------------------------------------- |
| page      | number | (Optional) The page number for pagination. Default is 1        |
| size      | number | (Optional) The number of items per page. Default is 10         |
| include   | string | (Optional) Specify 'count' to include the total count of items |
| asset     | string | (Optional) Filter by asset UUID                                |
| product   | string | (Optional) Filter by product UUID                              |
| type      | string | (Optional) Filter by revenue split type                        |
| user      | string | (Optional) Filter by user UUID                                 |
| q         | string | (Optional) Search query                                        |
| sort      | string | (Optional) Field to sort by                                    |
| order     | string | (Optional) Sort order (asc/desc)                               |

## Code Examples

<CodeGroup>
  ```javascript Node.js theme={null}
  const response = await fetch('https://api.royalti.io/split/', {
    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/',
    headers={
      'Authorization': f'Bearer {token}'
    },
  )

  data = response.json()
  print(data)
  ```

  ```bash cURL theme={null}
  curl -X GET https://api.royalti.io/split/ \
    -H "Authorization: Bearer YOUR_TOKEN" \

  ```
</CodeGroup>


## OpenAPI

````yaml get /split/
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/:
    get:
      tags:
        - Splits
      summary: Get splits
      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:**


        | Parameter | Type | Description |

        | --- | --- | --- |

        | page | number | (Optional) The page number for pagination. Default is
        1 |

        | size | number | (Optional) The number of items per page. Default is 10
        |

        | include | string | (Optional) Specify 'count' to include the total
        count of items |

        | asset | string | (Optional) Filter by asset UUID |

        | product | string | (Optional) Filter by product UUID |

        | type | string | (Optional) Filter by revenue split type |

        | user | string | (Optional) Filter by user UUID |

        | q | string | (Optional) Search query |

        | sort | string | (Optional) Field to sort by |

        | order | string | (Optional) Sort order (asc/desc) |
      parameters:
        - name: page
          in: query
          required: false
          description: The page number for pagination
          schema:
            type: integer
            default: 1
        - name: size
          in: query
          required: false
          description: The number of items per page
          schema:
            type: integer
            default: 10
        - name: include
          in: query
          required: false
          description: Specify 'count' to include the total count of items
          schema:
            type: string
        - name: asset
          in: query
          required: false
          description: Filter by asset UUID
          schema:
            type: string
            format: uuid
        - name: product
          in: query
          required: false
          description: Filter by product UUID
          schema:
            type: string
            format: uuid
        - name: type
          in: query
          required: false
          description: Filter by revenue split type
          schema:
            type: string
        - name: user
          in: query
          required: false
          description: Filter by user UUID
          schema:
            type: string
            format: uuid
        - name: q
          in: query
          required: false
          description: Search query
          schema:
            type: string
        - name: sort
          in: query
          required: false
          description: Field to sort by
          schema:
            type: string
        - name: order
          in: query
          required: false
          description: Sort order (asc/desc)
          schema:
            type: string
            enum:
              - asc
              - desc
        - name: includeCoverage
          in: query
          required: false
          description: Include temporal coverage analysis for splits with date ranges
          schema:
            type: boolean
            default: false
      responses:
        '200':
          description: Successfully retrieved splits
          content:
            application/json:
              schema:
                type: object
                properties:
                  totalItems:
                    type: integer
                    description: Total number of split configurations
                  Splits:
                    type: array
                    items:
                      $ref: '#/components/schemas/Split'
              example:
                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
        '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}"

````