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

> ### GET /releases

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

## Description

This endpoint retrieves releases with filtering, pagination, and sorting options.

**Query Parameters**

| Parameter | Type    | Description                                    |
| --------- | ------- | ---------------------------------------------- |
| status    | string  | Filter by release status                       |
| format    | string  | Filter by release format                       |
| type      | string  | Filter by release type                         |
| search    | string  | Search in title, displayArtist, or description |
| owner     | string  | Filter by owner user ID (UUID)                 |
| page      | integer | Page number for pagination (default: 1)        |
| limit     | integer | Number of items per page (default: 20)         |

## Code Examples

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

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

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

  ```
</CodeGroup>


## OpenAPI

````yaml get /releases
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:
  /releases:
    get:
      tags:
        - Release
      summary: Get Releases
      description: >-
        ### GET /releases


        This endpoint retrieves releases with filtering, pagination, and sorting
        options.


        **Query Parameters**


        | Parameter | Type | Description |

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

        | status | string | Filter by release status |

        | format | string | Filter by release format |

        | type | string | Filter by release type |

        | search | string | Search in title, displayArtist, or description |

        | owner | string | Filter by owner user ID (UUID) |

        | page | integer | Page number for pagination (default: 1) |

        | limit | integer | Number of items per page (default: 20) |
      parameters:
        - name: status
          in: query
          required: false
          description: Filter by release status
          schema:
            type: string
            enum:
              - draft
              - submitted
              - under_review
              - approved
              - rejected
              - completed
        - name: format
          in: query
          required: false
          description: Filter by release format
          schema:
            type: string
            enum:
              - Single
              - EP
              - Album
              - LP
              - Video
        - name: type
          in: query
          required: false
          description: Filter by release type
          schema:
            type: string
            enum:
              - Audio
              - Video
        - name: search
          in: query
          required: false
          description: Search in title, displayArtist, or description
          schema:
            type: string
        - name: page
          in: query
          required: false
          description: Page number for pagination
          schema:
            type: integer
            default: 1
        - name: limit
          in: query
          required: false
          description: Number of items per page
          schema:
            type: integer
            default: 20
        - name: owner
          in: query
          required: false
          description: Filter by owner user ID (UUID)
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  data:
                    type: object
                    properties:
                      releases:
                        type: array
                        items:
                          $ref: '#/components/schemas/Release'
                  pagination:
                    type: object
                    properties:
                      page:
                        type: integer
                      limit:
                        type: integer
                      total:
                        type: integer
                      totalPages:
                        type: integer
                  stats:
                    $ref: '#/components/schemas/ReleaseStats'
        '401':
          description: Unauthorized
          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:
    Release:
      type: object
      required:
        - id
        - TenantId
        - TenantUserId
        - title
        - displayArtist
        - artists
        - tracks
      properties:
        id:
          type: string
        TenantId:
          type: string
        TenantUserId:
          type: string
        title:
          type: string
        format:
          type: string
          example: Single
        type:
          type: string
          example: Audio
        version:
          type: string
          nullable: true
        label:
          type: string
          nullable: true
        copyright:
          type: string
          nullable: true
        displayArtist:
          type: string
        artists:
          type: array
          items:
            $ref: '#/components/schemas/ArtistReference'
          description: Array of artists with resolved names and types
        mainGenre:
          type: array
          items:
            type: string
        subGenre:
          type: array
          items:
            type: string
        contributors:
          type: array
          items:
            type: string
        description:
          type: string
          nullable: true
        metadata:
          type: object
          nullable: true
        media:
          type: array
          items:
            type: object
        explicit:
          type: string
          enum:
            - explicit
            - clean
          nullable: true
          description: 'Content rating: explicit, clean, or null (not specified)'
        releaseDate:
          type: string
          format: date-time
          nullable: true
        preReleaseDate:
          type: string
          format: date-time
          nullable: true
        status:
          type: string
        autoCreationStatus:
          type: string
          enum:
            - pending
            - success
            - failed
          nullable: true
          description: Status of auto-creation pipeline (null if not started)
        autoCreationError:
          type: string
          nullable: true
          description: Error message if auto-creation failed
        createdProductId:
          type: string
          format: uuid
          nullable: true
          description: UUID of Product created during auto-creation
        createdAssetIds:
          type: array
          items:
            type: string
            format: uuid
          nullable: true
          description: >-
            Array of Asset UUIDs created during auto-creation (excludes linked
            assets)
        tracks:
          type: array
          items:
            $ref: '#/components/schemas/ReleaseTrack'
        owner:
          type: object
          properties:
            id:
              type: string
            firstName:
              type: string
            lastName:
              type: string
            email:
              type: string
    ReleaseStats:
      type: object
      properties:
        total:
          type: integer
        totalPublished:
          type: integer
        totalDrafts:
          type: integer
        totalRejected:
          type: integer
        totalPending:
          type: integer
        totalScheduled:
          type: integer
        mainGenre:
          type: array
          items:
            type: string
          example:
            - Pop
        subGenre:
          type: array
          items:
            type: string
          example:
            - Alternative R&B
        contributors:
          type: array
          items:
            type: object
            properties:
              role:
                type: string
                example: Producer
              name:
                type: string
                example: John Doe
              isni:
                type: string
                nullable: true
                example: '0000000123456789'
        metadata:
          type: object
          additionalProperties: true
        explicit:
          type: string
          enum:
            - explicit
            - clean
          nullable: true
          default: null
          description: 'Content rating: explicit, clean, or null (not specified)'
    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
    ArtistReference:
      type: object
      required:
        - id
        - artistName
        - type
      properties:
        id:
          type: string
          format: uuid
          description: Artist UUID
          example: 3816be64-720c-4105-990f-a6b99b0f928b
        artistName:
          type: string
          description: Artist name
          example: Bally Jhay
        type:
          type: string
          enum:
            - primary
            - featuring
          description: Artist role
          example: primary
    ReleaseTrack:
      type: object
      properties:
        id:
          type: string
          format: uuid
          example: 550e8400-e29b-41d4-a716-446655440000
        TenantId:
          type: integer
          example: 123
        ReleaseId:
          type: string
          format: uuid
          example: 660e8400-e29b-41d4-a716-446655441111
        assetId:
          type: string
          format: uuid
          nullable: true
          description: Reference to linked Asset (if any)
          example: 770e8400-e29b-41d4-a716-446655442222
        trackNumber:
          type: integer
          example: 1
        title:
          type: string
          example: My Track Title
        version:
          type: string
          nullable: true
          example: Radio Edit
        isrc:
          type: string
          nullable: true
          example: USABC1234567
        iswc:
          type: string
          nullable: true
          example: T-123456789-0
        duration:
          type: number
          format: float
          nullable: true
          example: 213.5
        lyrics:
          type: string
          nullable: true
          example: |-
            Verse 1
            Chorus
            Verse 2
        language:
          type: string
          example: en
        displayArtist:
          type: string
          example: Artist Name
        artists:
          type: array
          items:
            $ref: '#/components/schemas/ArtistReference'
          description: Array of artists with resolved names and types
          example:
            - id: 550e8400-e29b-41d4-a716-446655440000
              artistName: John Doe
              type: primary
            - id: 660e8400-e29b-41d4-a716-446655441111
              artistName: Jane Smith
              type: featuring
        mainGenre:
          type: array
          items:
            type: string
          example:
            - Pop
            - Rock
        subGenre:
          type: array
          items:
            type: string
          example:
            - Alternative
        contributors:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          example:
            producer:
              - Producer Name
            songwriter:
              - Writer Name
        media:
          type: array
          items:
            $ref: '#/components/schemas/Media'
        metadata:
          type: object
          additionalProperties: true
          example:
            bpm: 120
            key: C Major
        explicit:
          type: string
          enum:
            - explicit
            - clean
          nullable: true
          description: 'Content rating: explicit, clean, or null (not specified)'
          example: false
    Media:
      type: object
      properties:
        cloudId:
          type: string
          description: Cloud storage file ID or unique identifier for links
          example: 550e8400-e29b-41d4-a716-446655440000
        cloudUrl:
          type: string
          format: uri
          description: Public URL from cloud storage OR the submitted link URL
          example: https://storage.royalti.io/files/audio.mp3
        type:
          type: string
          enum:
            - audio
            - video
            - image
            - document
          description: File type
          example: audio
        name:
          type: string
          description: File name or link title
          example: my-track.mp3
        isLink:
          type: boolean
          description: Flag to distinguish links from files
          example: false
        releasePath:
          type: string
          description: Temporary release storage path (for files only)
          nullable: true
          example: tenant123/releases/release456/tracks/track789/file.mp3
        metadata:
          type: object
          description: Additional metadata
          properties:
            duration:
              type: number
              format: float
              description: Duration in seconds
              example: 213.5
            bitrate:
              type: string
              description: Audio bitrate
              example: '320'
            sampleRate:
              type: string
              description: Audio sample rate
              example: '44100'
            channels:
              type: string
              description: Audio channels
              example: '2'
            codec:
              type: string
              description: Audio/video codec
              example: mp3
            fileSize:
              type: number
              description: File size in bytes
              example: 1048576
            mimeType:
              type: string
              description: MIME type
              example: audio/mpeg
            processedAt:
              type: string
              format: date-time
              description: Processing timestamp
            linkValidated:
              type: boolean
              description: For link submissions - validation status
              example: true
          additionalProperties: true
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        JWT Authorization header using the Bearer scheme. Format: "Bearer
        {token}"

````