Skip to main content
GET
/
releases
Get Releases
curl --request GET \
  --url https://server26-dot-royalti-project.uc.r.appspot.com/releases \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": {
    "releases": [
      {
        "id": "<string>",
        "TenantId": "<string>",
        "TenantUserId": "<string>",
        "title": "<string>",
        "format": "Single",
        "type": "Audio",
        "version": "<string>",
        "label": "<string>",
        "copyright": "<string>",
        "displayArtist": "<string>",
        "artists": [
          {
            "id": "3816be64-720c-4105-990f-a6b99b0f928b",
            "artistName": "Bally Jhay",
            "type": "primary"
          }
        ],
        "mainGenre": [
          "<string>"
        ],
        "subGenre": [
          "<string>"
        ],
        "contributors": [
          "<string>"
        ],
        "description": "<string>",
        "metadata": {},
        "media": [
          {}
        ],
        "explicit": "explicit",
        "releaseDate": "2023-11-07T05:31:56Z",
        "preReleaseDate": "2023-11-07T05:31:56Z",
        "status": "<string>",
        "tracks": [
          {
            "id": "550e8400-e29b-41d4-a716-446655440000",
            "TenantId": 123,
            "ReleaseId": "660e8400-e29b-41d4-a716-446655441111",
            "assetId": "770e8400-e29b-41d4-a716-446655442222",
            "trackNumber": 1,
            "title": "My Track Title",
            "version": "Radio Edit",
            "isrc": "USABC1234567",
            "iswc": "T-123456789-0",
            "duration": 213.5,
            "lyrics": "Verse 1\nChorus\nVerse 2",
            "language": "en",
            "displayArtist": "Artist Name",
            "artists": [
              {
                "id": "550e8400-e29b-41d4-a716-446655440000",
                "artistName": "John Doe",
                "type": "primary"
              },
              {
                "id": "660e8400-e29b-41d4-a716-446655441111",
                "artistName": "Jane Smith",
                "type": "featuring"
              }
            ],
            "mainGenre": [
              "Pop",
              "Rock"
            ],
            "subGenre": [
              "Alternative"
            ],
            "contributors": {
              "producer": [
                "Producer Name"
              ],
              "songwriter": [
                "Writer Name"
              ]
            },
            "media": [
              {
                "cloudId": "550e8400-e29b-41d4-a716-446655440000",
                "cloudUrl": "https://storage.royalti.io/files/audio.mp3",
                "type": "audio",
                "name": "my-track.mp3",
                "isLink": false,
                "releasePath": "tenant123/releases/release456/tracks/track789/file.mp3",
                "metadata": {
                  "duration": 213.5,
                  "bitrate": "320",
                  "sampleRate": "44100",
                  "channels": "2",
                  "codec": "mp3",
                  "fileSize": 1048576,
                  "mimeType": "audio/mpeg",
                  "processedAt": "2023-11-07T05:31:56Z",
                  "linkValidated": true
                }
              }
            ],
            "metadata": {
              "bpm": 120,
              "key": "C Major"
            },
            "explicit": false
          }
        ],
        "owner": {
          "id": "<string>",
          "firstName": "<string>",
          "lastName": "<string>",
          "email": "<string>"
        }
      }
    ]
  },
  "pagination": {
    "page": 123,
    "limit": 123,
    "total": 123,
    "totalPages": 123
  },
  "stats": {
    "total": 123,
    "totalPublished": 123,
    "totalDrafts": 123,
    "totalRejected": 123,
    "totalPending": 123,
    "totalScheduled": 123,
    "mainGenre": [
      "Pop"
    ],
    "subGenre": [
      "Alternative R&B"
    ],
    "contributors": [
      {
        "role": "Producer",
        "name": "John Doe",
        "isni": "0000000123456789"
      }
    ],
    "metadata": {},
    "explicit": null
  }
}

GET /releases

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

Query Parameters

  • status: Filter by release status
  • format: Filter by release format
  • type: Filter by release type
  • search: Search in title, displayArtist, or description
  • page: Page number for pagination (default: 1)
  • limit: Number of items per page (default: 20)
  • sortBy: Field to sort by (default: updatedAt)
  • sortOrder: Sort order (asc/desc, default: desc)
  • includeStats: Include statistics in response

Authentication

This endpoint requires authentication. Include your bearer token in the Authorization header.

Query Parameters

ParameterTypeInRequiredDescription
statusstringqueryFilter by release status
formatstringqueryFilter by release format
typestringqueryFilter by release type
searchstringquerySearch in title, displayArtist, or description
pageintegerqueryPage number for pagination
limitintegerqueryNumber of items per page
sortBystringqueryField to sort by
sortOrderstringquerySort order
includeStatsbooleanqueryInclude statistics in response

Responses

✅ 200 - Success

⚠️ 401 - Unauthorized

❌ 500 - Internal Server Error

Tags

Release

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"

Query Parameters

status
enum<string>

Filter by release status

Available options:
draft,
submitted,
under_review,
approved,
rejected,
completed
format
enum<string>

Filter by release format

Available options:
Single,
EP,
Album,
Compilation,
Soundtrack,
Live,
Remix,
Remaster
type
enum<string>

Filter by release type

Available options:
Audio,
Video,
Mixed

Search in title, displayArtist, or description

page
integer
default:1

Page number for pagination

limit
integer
default:20

Number of items per page

sortBy
string
default:updatedAt

Field to sort by

sortOrder
enum<string>
default:desc

Sort order

Available options:
asc,
desc
includeStats
boolean
default:false

Include statistics in response

Response

Success

success
boolean
Example:

true

data
object
pagination
object
stats
object
I