{
"openapi": "3.0.1",
"info": {
"contact": {
"name": "TIDAL Developer - Discussions",
"url": "https://github.com/orgs/tidal-music/discussions"
},
"description": "The TIDAL API is a [JSON:API](https://jsonapi.org/)–compliant web API that exposes TIDAL’s music, metadata, and user-related functionality through a consistent, resource-oriented design. More information and API management are available at [developer.tidal.com](developer.tidal.com)",
"termsOfService": "https://developer.tidal.com/documentation/guidelines/guidelines-overview",
"title": "TIDAL API",
"version": "1.0.36"
},
"externalDocs": {
"description": "TIDAL Developer - Documentation",
"url": "https://developer.tidal.com/documentation"
},
"servers": [
{
"url": "https://openapi.tidal.com/v2",
"description": "Production"
}
],
"tags": [
{
"name": "albums"
},
{
"name": "appreciations"
},
{
"name": "artistBiographies"
},
{
"name": "artistClaims"
},
{
"name": "artistRoles"
},
{
"name": "artists"
},
{
"name": "artworks"
},
{
"name": "dynamicPages"
},
{
"name": "genres"
},
{
"name": "lyrics"
},
{
"name": "manualArtistClaims"
},
{
"name": "playQueues"
},
{
"name": "playlists"
},
{
"name": "providers"
},
{
"name": "reactions"
},
{
"name": "savedShares"
},
{
"name": "searchResults"
},
{
"name": "searchSuggestions"
},
{
"name": "shares"
},
{
"name": "stripeConnections"
},
{
"name": "trackFiles"
},
{
"name": "trackManifests"
},
{
"description": "A track source file is the media source file of a track, meaning audio content.\nAfter a track source file is uploaded successfully it will be ingested and transcoded into deliverables and\nstored like any other content we receive from labels.\n",
"name": "trackSourceFiles"
},
{
"name": "trackStatistics"
},
{
"name": "tracks"
},
{
"name": "userCollectionFolders"
},
{
"name": "userCollections"
},
{
"name": "userEntitlements"
},
{
"name": "userRecommendations"
},
{
"name": "userReports"
},
{
"name": "users"
},
{
"name": "videos"
}
],
"paths": {
"/albums": {
"get": {
"operationId": "getAlbums",
"description": "Retrieves multiple albums by available filters, or without if applicable.",
"parameters": [
{
"description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "ISO 3166-1 alpha-2 country code",
"example": "US",
"in": "query",
"name": "countryCode",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: artists, coverArt, genres, items, owners, providers, replacement, similarAlbums, suggestedCoverArts",
"example": "artists",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "artists"
}
}
},
{
"description": "Barcode Id",
"example": "196589525444",
"in": "query",
"name": "filter[barcodeId]",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "196589525444"
}
}
},
{
"description": "Album id",
"example": "251380836",
"in": "query",
"name": "filter[id]",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "251380836"
}
}
},
{
"description": "User id",
"example": "123456",
"in": "query",
"name": "filter[owners.id]",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "123456"
}
}
},
{
"description": "Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted.",
"in": "query",
"name": "shareCode",
"required": false,
"schema": {
"type": "string",
"example": "xyz"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Albums_Multi_Resource_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Client_Credentials": []
},
{
"Authorization_Code_PKCE": ["r_usr"]
}
],
"summary": "Get multiple albums.",
"tags": ["albums"],
"x-path-item-properties": {
"required-access-tier": "THIRD_PARTY"
}
},
"post": {
"operationId": "createAlbum",
"description": "Creates a new album.",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AlbumCreateOperation_Payload"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Albums_Single_Resource_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["w_usr"]
}
],
"summary": "Create single album.",
"tags": ["albums"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
}
},
"/albums/{id}": {
"delete": {
"operationId": "deleteAlbum",
"description": "Deletes existing album.",
"parameters": [
{
"description": "Album id",
"example": "251380836",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["w_usr"]
}
],
"summary": "Delete single album.",
"tags": ["albums"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
},
"get": {
"operationId": "getAlbum",
"description": "Retrieves single album by id.",
"parameters": [
{
"description": "Album id",
"example": "251380836",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "ISO 3166-1 alpha-2 country code",
"example": "US",
"in": "query",
"name": "countryCode",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: artists, coverArt, genres, items, owners, providers, replacement, similarAlbums, suggestedCoverArts",
"example": "artists",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "artists"
}
}
},
{
"description": "Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted.",
"in": "query",
"name": "shareCode",
"required": false,
"schema": {
"type": "string",
"example": "xyz"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Albums_Single_Resource_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Client_Credentials": []
},
{
"Authorization_Code_PKCE": []
}
],
"summary": "Get single album.",
"tags": ["albums"],
"x-path-item-properties": {
"required-access-tier": "THIRD_PARTY"
}
},
"patch": {
"operationId": "patchAlbum",
"description": "Updates existing album.",
"parameters": [
{
"description": "Album id",
"example": "251380836",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AlbumUpdateOperation_Payload"
}
}
}
},
"responses": {
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["w_usr"]
}
],
"summary": "Update single album.",
"tags": ["albums"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
}
},
"/albums/{id}/relationships/artists": {
"get": {
"operationId": "getAlbumArtists",
"description": "Retrieves artists relationship.",
"parameters": [
{
"description": "Album id",
"example": "251380836",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "ISO 3166-1 alpha-2 country code",
"example": "US",
"in": "query",
"name": "countryCode",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: artists",
"example": "artists",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "artists"
}
}
},
{
"description": "Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted.",
"in": "query",
"name": "shareCode",
"required": false,
"schema": {
"type": "string",
"example": "xyz"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Albums_Multi_Relationship_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Client_Credentials": []
},
{
"Authorization_Code_PKCE": []
}
],
"summary": "Get artists relationship (\"to-many\").",
"tags": ["albums"],
"x-path-item-properties": {
"required-access-tier": "THIRD_PARTY"
}
}
},
"/albums/{id}/relationships/coverArt": {
"get": {
"operationId": "getAlbumCoverArt",
"description": "Retrieves coverArt relationship.",
"parameters": [
{
"description": "Album id",
"example": "251380836",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "ISO 3166-1 alpha-2 country code",
"example": "US",
"in": "query",
"name": "countryCode",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: coverArt",
"example": "coverArt",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "coverArt"
}
}
},
{
"description": "Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted.",
"in": "query",
"name": "shareCode",
"required": false,
"schema": {
"type": "string",
"example": "xyz"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Albums_Multi_Relationship_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Client_Credentials": []
},
{
"Authorization_Code_PKCE": []
}
],
"summary": "Get coverArt relationship (\"to-many\").",
"tags": ["albums"],
"x-path-item-properties": {
"required-access-tier": "THIRD_PARTY"
}
},
"patch": {
"operationId": "patchAlbumCoverArt",
"description": "Updates coverArt relationship.",
"parameters": [
{
"description": "Album id",
"example": "251380836",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AlbumCoverArtRelationshipUpdateOperation_Payload"
}
}
}
},
"responses": {
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["w_usr"]
}
],
"summary": "Update coverArt relationship (\"to-many\").",
"tags": ["albums"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
}
},
"/albums/{id}/relationships/genres": {
"get": {
"operationId": "getAlbumGenres",
"description": "Retrieves genres relationship.",
"parameters": [
{
"description": "Album id",
"example": "251380836",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "ISO 3166-1 alpha-2 country code",
"example": "US",
"in": "query",
"name": "countryCode",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: genres",
"example": "genres",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "genres"
}
}
},
{
"description": "Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted.",
"in": "query",
"name": "shareCode",
"required": false,
"schema": {
"type": "string",
"example": "xyz"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Albums_Multi_Relationship_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Client_Credentials": []
},
{
"Authorization_Code_PKCE": []
}
],
"summary": "Get genres relationship (\"to-many\").",
"tags": ["albums"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
}
},
"/albums/{id}/relationships/items": {
"get": {
"operationId": "getAlbumItems",
"description": "Retrieves items relationship.",
"parameters": [
{
"description": "Album id",
"example": "251380836",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "ISO 3166-1 alpha-2 country code",
"example": "US",
"in": "query",
"name": "countryCode",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: items",
"example": "items",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "items"
}
}
},
{
"description": "Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted.",
"in": "query",
"name": "shareCode",
"required": false,
"schema": {
"type": "string",
"example": "xyz"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Albums_Items_Multi_Relationship_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Client_Credentials": []
},
{
"Authorization_Code_PKCE": []
}
],
"summary": "Get items relationship (\"to-many\").",
"tags": ["albums"],
"x-path-item-properties": {
"required-access-tier": "THIRD_PARTY"
}
},
"patch": {
"operationId": "patchALbumItems",
"description": "Updates items relationship.",
"parameters": [
{
"description": "Album id",
"example": "251380836",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AlbumItemsRelationshipUpdateOperation_Payload"
}
}
}
},
"responses": {
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["w_usr"]
}
],
"summary": "Update items relationship (\"to-many\").",
"tags": ["albums"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
}
},
"/albums/{id}/relationships/owners": {
"get": {
"operationId": "getAlbumOwners",
"description": "Retrieves owners relationship.",
"parameters": [
{
"description": "Album id",
"example": "251380836",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: owners",
"example": "owners",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "owners"
}
}
},
{
"description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted.",
"in": "query",
"name": "shareCode",
"required": false,
"schema": {
"type": "string",
"example": "xyz"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Albums_Multi_Relationship_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Client_Credentials": []
},
{
"Authorization_Code_PKCE": []
}
],
"summary": "Get owners relationship (\"to-many\").",
"tags": ["albums"],
"x-path-item-properties": {
"required-access-tier": "THIRD_PARTY"
}
}
},
"/albums/{id}/relationships/providers": {
"get": {
"operationId": "getAlbumProviders",
"description": "Retrieves providers relationship.",
"parameters": [
{
"description": "Album id",
"example": "251380836",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "ISO 3166-1 alpha-2 country code",
"example": "US",
"in": "query",
"name": "countryCode",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: providers",
"example": "providers",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "providers"
}
}
},
{
"description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted.",
"in": "query",
"name": "shareCode",
"required": false,
"schema": {
"type": "string",
"example": "xyz"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Albums_Multi_Relationship_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Client_Credentials": []
},
{
"Authorization_Code_PKCE": []
}
],
"summary": "Get providers relationship (\"to-many\").",
"tags": ["albums"],
"x-path-item-properties": {
"required-access-tier": "THIRD_PARTY"
}
}
},
"/albums/{id}/relationships/replacement": {
"get": {
"operationId": "getAlbumReplacementReplationship",
"description": "Retrieves replacement relationship.",
"parameters": [
{
"description": "Album id",
"example": "251380836",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "ISO 3166-1 alpha-2 country code",
"example": "US",
"in": "query",
"name": "countryCode",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: replacement",
"example": "replacement",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "replacement"
}
}
},
{
"description": "Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted.",
"in": "query",
"name": "shareCode",
"required": false,
"schema": {
"type": "string",
"example": "xyz"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Albums_Single_Relationship_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Client_Credentials": []
},
{
"Authorization_Code_PKCE": []
}
],
"summary": "Get replacement relationship (\"to-one\").",
"tags": ["albums"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
}
},
"/albums/{id}/relationships/similarAlbums": {
"get": {
"operationId": "getSimilarAlbums",
"description": "Retrieves similarAlbums relationship.",
"parameters": [
{
"description": "Album id",
"example": "251380836",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "ISO 3166-1 alpha-2 country code",
"example": "US",
"in": "query",
"name": "countryCode",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: similarAlbums",
"example": "similarAlbums",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "similarAlbums"
}
}
},
{
"description": "Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted.",
"in": "query",
"name": "shareCode",
"required": false,
"schema": {
"type": "string",
"example": "xyz"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Albums_Multi_Relationship_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Client_Credentials": []
},
{
"Authorization_Code_PKCE": []
}
],
"summary": "Get similarAlbums relationship (\"to-many\").",
"tags": ["albums"],
"x-path-item-properties": {
"required-access-tier": "THIRD_PARTY"
}
}
},
"/albums/{id}/relationships/suggestedCoverArts": {
"get": {
"operationId": "getAlbumSuggestedCoverArts",
"description": "Retrieves suggestedCoverArts relationship.",
"parameters": [
{
"description": "Album id",
"example": "251380836",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: suggestedCoverArts",
"example": "suggestedCoverArts",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "suggestedCoverArts"
}
}
},
{
"description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted.",
"in": "query",
"name": "shareCode",
"required": false,
"schema": {
"type": "string",
"example": "xyz"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Albums_SuggestedCoverArts_Multi_Relationship_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["r_usr"]
}
],
"summary": "Get suggestedCoverArts relationship (\"to-many\").",
"tags": ["albums"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
}
},
"/appreciations": {
"post": {
"operationId": "createAppreciation",
"description": "Creates a new appreciation.",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AppreciationsCreateOperation_Payload"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Appreciations_Single_Resource_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["w_usr"]
}
],
"summary": "Create single appreciation.",
"tags": ["appreciations"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
}
},
"/artistBiographies": {
"get": {
"operationId": "getArtistBiographies",
"description": "Retrieves multiple artistBiographies by available filters, or without if applicable.",
"parameters": [
{
"description": "ISO 3166-1 alpha-2 country code",
"example": "US",
"in": "query",
"name": "countryCode",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: owners",
"example": "owners",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "owners"
}
}
},
{
"description": "Artist id",
"example": "1566",
"in": "query",
"name": "filter[id]",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "1566"
}
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ArtistBiographies_Multi_Resource_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Client_Credentials": []
},
{
"Authorization_Code_PKCE": []
}
],
"summary": "Get multiple artistBiographies.",
"tags": ["artistBiographies"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
}
},
"/artistBiographies/{id}": {
"get": {
"operationId": "getArtistBiography",
"description": "Retrieves single artistBiographie by id.",
"parameters": [
{
"description": "Artist biography id",
"example": "123456",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "ISO 3166-1 alpha-2 country code",
"example": "US",
"in": "query",
"name": "countryCode",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: owners",
"example": "owners",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "owners"
}
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ArtistBiographies_Single_Resource_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Client_Credentials": []
},
{
"Authorization_Code_PKCE": []
}
],
"summary": "Get single artistBiographie.",
"tags": ["artistBiographies"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
},
"patch": {
"operationId": "patchArtistBiography",
"description": "Updates existing artistBiographie.",
"parameters": [
{
"description": "Artist biography id",
"example": "123456",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ArtistBiographyUpdateBody"
}
}
}
},
"responses": {
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["w_usr"]
}
],
"summary": "Update single artistBiographie.",
"tags": ["artistBiographies"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
}
},
"/artistBiographies/{id}/relationships/owners": {
"get": {
"operationId": "getArtistBiographyOwners",
"description": "Retrieves owners relationship.",
"parameters": [
{
"description": "Artist biography id",
"example": "123456",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: owners",
"example": "owners",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "owners"
}
}
},
{
"description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ArtistBiographies_Multi_Relationship_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Client_Credentials": []
},
{
"Authorization_Code_PKCE": []
}
],
"summary": "Get owners relationship (\"to-many\").",
"tags": ["artistBiographies"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
}
},
"/artistClaims": {
"post": {
"operationId": "createArtistClaim",
"description": "Creates a new artistClaim.",
"parameters": [
{
"description": "ISO 3166-1 alpha-2 country code",
"example": "US",
"in": "query",
"name": "countryCode",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ArtistClaimsCreateOperation_Payload"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ArtistClaims_Single_Resource_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["w_usr"]
}
],
"summary": "Create single artistClaim.",
"tags": ["artistClaims"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
}
},
"/artistClaims/{id}": {
"get": {
"operationId": "getArtistClaim",
"description": "Retrieves single artistClaim by id.",
"parameters": [
{
"description": "Artist claim id",
"example": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: acceptedArtists, owners, recommendedArtists",
"example": "acceptedArtists",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "acceptedArtists"
}
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ArtistClaims_Single_Resource_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["r_usr"]
}
],
"summary": "Get single artistClaim.",
"tags": ["artistClaims"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
},
"patch": {
"operationId": "patchArtistClaim",
"description": "Updates existing artistClaim.",
"parameters": [
{
"description": "Artist claim id",
"example": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "ISO 3166-1 alpha-2 country code",
"example": "US",
"in": "query",
"name": "countryCode",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ArtistClaimsUpdateOperation_Payload"
}
}
}
},
"responses": {
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["w_usr"]
}
],
"summary": "Update single artistClaim.",
"tags": ["artistClaims"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
}
},
"/artistClaims/{id}/relationships/acceptedArtists": {
"get": {
"operationId": "getArtistClaimAcceptedArtists",
"description": "Retrieves acceptedArtists relationship.",
"parameters": [
{
"description": "Artist claim id",
"example": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: acceptedArtists",
"example": "acceptedArtists",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "acceptedArtists"
}
}
},
{
"description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ArtistClaims_Multi_Relationship_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["r_usr"]
}
],
"summary": "Get acceptedArtists relationship (\"to-many\").",
"tags": ["artistClaims"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
},
"patch": {
"operationId": "updateArtistClaimAcceptedArtists",
"description": "Updates acceptedArtists relationship.",
"parameters": [
{
"description": "Artist claim id",
"example": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "ISO 3166-1 alpha-2 country code",
"example": "US",
"in": "query",
"name": "countryCode",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ArtistClaimAcceptedArtistsRelationshipUpdateOperation_Payload"
}
}
}
},
"responses": {
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["w_usr"]
}
],
"summary": "Update acceptedArtists relationship (\"to-many\").",
"tags": ["artistClaims"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
}
},
"/artistClaims/{id}/relationships/owners": {
"get": {
"operationId": "getArtistClaimOwners",
"description": "Retrieves owners relationship.",
"parameters": [
{
"description": "Artist claim id",
"example": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: owners",
"example": "owners",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "owners"
}
}
},
{
"description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ArtistClaims_Multi_Relationship_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["r_usr"]
}
],
"summary": "Get owners relationship (\"to-many\").",
"tags": ["artistClaims"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
}
},
"/artistClaims/{id}/relationships/recommendedArtists": {
"get": {
"operationId": "getArtistClaimRecommendedArtists",
"description": "Retrieves recommendedArtists relationship.",
"parameters": [
{
"description": "Artist claim id",
"example": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: recommendedArtists",
"example": "recommendedArtists",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "recommendedArtists"
}
}
},
{
"description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ArtistClaims_Multi_Relationship_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["r_usr"]
}
],
"summary": "Get recommendedArtists relationship (\"to-many\").",
"tags": ["artistClaims"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
}
},
"/artistRoles": {
"get": {
"operationId": "getArtistRoles",
"description": "Retrieves multiple artistRoles by available filters, or without if applicable.",
"parameters": [
{
"description": "Artist role id",
"example": "1",
"in": "query",
"name": "filter[id]",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "1"
}
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ArtistRoles_Multi_Resource_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Client_Credentials": []
},
{
"Authorization_Code_PKCE": []
}
],
"summary": "Get multiple artistRoles.",
"tags": ["artistRoles"],
"x-path-item-properties": {
"required-access-tier": "THIRD_PARTY"
}
}
},
"/artistRoles/{id}": {
"get": {
"operationId": "getArtistRole",
"description": "Retrieves single artistRole by id.",
"parameters": [
{
"description": "Artist role id",
"example": "1",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ArtistRoles_Single_Resource_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Client_Credentials": []
},
{
"Authorization_Code_PKCE": []
}
],
"summary": "Get single artistRole.",
"tags": ["artistRoles"],
"x-path-item-properties": {
"required-access-tier": "THIRD_PARTY"
}
}
},
"/artists": {
"get": {
"operationId": "getArtists",
"description": "Retrieves multiple artists by available filters, or without if applicable.",
"parameters": [
{
"description": "ISO 3166-1 alpha-2 country code",
"example": "US",
"in": "query",
"name": "countryCode",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: albums, biography, followers, following, owners, profileArt, radio, roles, similarArtists, trackProviders, tracks, videos",
"example": "albums",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "albums"
}
}
},
{
"description": "Artist handle",
"example": "jayz",
"in": "query",
"name": "filter[handle]",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "jayz"
}
}
},
{
"description": "Artist id",
"example": "1566",
"in": "query",
"name": "filter[id]",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "1566"
}
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Artists_Multi_Resource_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Client_Credentials": []
},
{
"Authorization_Code_PKCE": []
}
],
"summary": "Get multiple artists.",
"tags": ["artists"],
"x-path-item-properties": {
"required-access-tier": "THIRD_PARTY"
}
},
"post": {
"operationId": "createArtist",
"description": "Creates a new artist.",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ArtistCreateOperation_Payload"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Artists_Single_Resource_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["w_usr"]
}
],
"summary": "Create single artist.",
"tags": ["artists"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
}
},
"/artists/{id}": {
"get": {
"operationId": "getArtist",
"description": "Retrieves single artist by id.",
"parameters": [
{
"description": "Artist id",
"example": "1566",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "ISO 3166-1 alpha-2 country code",
"example": "US",
"in": "query",
"name": "countryCode",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: albums, biography, followers, following, owners, profileArt, radio, roles, similarArtists, trackProviders, tracks, videos",
"example": "albums",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "albums"
}
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Artists_Single_Resource_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Client_Credentials": []
},
{
"Authorization_Code_PKCE": []
}
],
"summary": "Get single artist.",
"tags": ["artists"],
"x-path-item-properties": {
"required-access-tier": "THIRD_PARTY"
}
},
"patch": {
"operationId": "patchArtist",
"description": "Updates existing artist.",
"parameters": [
{
"description": "Artist id",
"example": "1566",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ArtistUpdateBody"
}
}
}
},
"responses": {
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["w_usr"]
}
],
"summary": "Update single artist.",
"tags": ["artists"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
}
},
"/artists/{id}/relationships/albums": {
"get": {
"operationId": "getArtistAlbums",
"description": "Retrieves albums relationship.",
"parameters": [
{
"description": "Artist id",
"example": "1566",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "ISO 3166-1 alpha-2 country code",
"example": "US",
"in": "query",
"name": "countryCode",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: albums",
"example": "albums",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "albums"
}
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Artists_Multi_Relationship_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Client_Credentials": []
},
{
"Authorization_Code_PKCE": []
}
],
"summary": "Get albums relationship (\"to-many\").",
"tags": ["artists"],
"x-path-item-properties": {
"required-access-tier": "THIRD_PARTY"
}
}
},
"/artists/{id}/relationships/biography": {
"get": {
"operationId": "getArtistArtistBiography",
"description": "Retrieves biography relationship.",
"parameters": [
{
"description": "Artist id",
"example": "1566",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "ISO 3166-1 alpha-2 country code",
"example": "US",
"in": "query",
"name": "countryCode",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: biography",
"example": "biography",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "biography"
}
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Artists_Single_Relationship_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Client_Credentials": []
},
{
"Authorization_Code_PKCE": []
}
],
"summary": "Get biography relationship (\"to-one\").",
"tags": ["artists"],
"x-path-item-properties": {
"required-access-tier": "THIRD_PARTY"
}
}
},
"/artists/{id}/relationships/followers": {
"get": {
"operationId": "getArtistFollowers",
"description": "Retrieves followers relationship.",
"parameters": [
{
"description": "Artist id",
"example": "1566",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "viewerContext",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: followers",
"example": "followers",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "followers"
}
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Artists_Followers_Multi_Relationship_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": []
}
],
"summary": "Get followers relationship (\"to-many\").",
"tags": ["artists"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
}
},
"/artists/{id}/relationships/following": {
"delete": {
"operationId": "deleteArtistFollowers",
"description": "Deletes item(s) from following relationship.",
"parameters": [
{
"description": "Artist id",
"example": "1566",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ArtistFollowingRelationshipRemoveOperation_Payload"
}
}
}
},
"responses": {
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["w_usr"]
}
],
"summary": "Delete from following relationship (\"to-many\").",
"tags": ["artists"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
},
"get": {
"operationId": "getArtistFollower",
"description": "Retrieves following relationship.",
"parameters": [
{
"description": "Artist id",
"example": "1566",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "viewerContext",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: following",
"example": "following",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "following"
}
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Artists_Following_Multi_Relationship_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": []
}
],
"summary": "Get following relationship (\"to-many\").",
"tags": ["artists"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
},
"post": {
"operationId": "addArtistFollowers",
"description": "Adds item(s) to following relationship.",
"parameters": [
{
"description": "Artist id",
"example": "1566",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "ISO 3166-1 alpha-2 country code",
"example": "US",
"in": "query",
"name": "countryCode",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ArtistFollowingRelationshipAddOperation_Payload"
}
}
}
},
"responses": {
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["w_usr"]
}
],
"summary": "Add to following relationship (\"to-many\").",
"tags": ["artists"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
}
},
"/artists/{id}/relationships/owners": {
"get": {
"operationId": "getArtistOwners",
"description": "Retrieves owners relationship.",
"parameters": [
{
"description": "Artist id",
"example": "1566",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: owners",
"example": "owners",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "owners"
}
}
},
{
"description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Artists_Multi_Relationship_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Client_Credentials": []
},
{
"Authorization_Code_PKCE": []
}
],
"summary": "Get owners relationship (\"to-many\").",
"tags": ["artists"],
"x-path-item-properties": {
"required-access-tier": "THIRD_PARTY"
}
}
},
"/artists/{id}/relationships/profileArt": {
"get": {
"operationId": "getArtistProfileArt",
"description": "Retrieves profileArt relationship.",
"parameters": [
{
"description": "Artist id",
"example": "1566",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "ISO 3166-1 alpha-2 country code",
"example": "US",
"in": "query",
"name": "countryCode",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: profileArt",
"example": "profileArt",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "profileArt"
}
}
},
{
"description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Artists_Multi_Relationship_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Client_Credentials": []
},
{
"Authorization_Code_PKCE": []
}
],
"summary": "Get profileArt relationship (\"to-many\").",
"tags": ["artists"],
"x-path-item-properties": {
"required-access-tier": "THIRD_PARTY"
}
},
"patch": {
"operationId": "patchArtistProfileArt",
"description": "Updates profileArt relationship.",
"parameters": [
{
"description": "Artist id",
"example": "1566",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ArtistProfileArtRelationshipUpdateOperation_Payload"
}
}
}
},
"responses": {
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["w_usr"]
}
],
"summary": "Update profileArt relationship (\"to-many\").",
"tags": ["artists"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
}
},
"/artists/{id}/relationships/radio": {
"get": {
"operationId": "getArtistRadio",
"description": "Retrieves radio relationship.",
"parameters": [
{
"description": "Artist id",
"example": "1566",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "ISO 3166-1 alpha-2 country code",
"example": "US",
"in": "query",
"name": "countryCode",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: radio",
"example": "radio",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "radio"
}
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Artists_Multi_Relationship_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Client_Credentials": []
},
{
"Authorization_Code_PKCE": []
}
],
"summary": "Get radio relationship (\"to-many\").",
"tags": ["artists"],
"x-path-item-properties": {
"required-access-tier": "THIRD_PARTY"
}
}
},
"/artists/{id}/relationships/roles": {
"get": {
"operationId": "getArtistArtistRoles",
"description": "Retrieves roles relationship.",
"parameters": [
{
"description": "Artist id",
"example": "1566",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: roles",
"example": "roles",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "roles"
}
}
},
{
"description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Artists_Multi_Relationship_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Client_Credentials": []
},
{
"Authorization_Code_PKCE": []
}
],
"summary": "Get roles relationship (\"to-many\").",
"tags": ["artists"],
"x-path-item-properties": {
"required-access-tier": "THIRD_PARTY"
}
}
},
"/artists/{id}/relationships/similarArtists": {
"get": {
"operationId": "getArtistSimilarArtists",
"description": "Retrieves similarArtists relationship.",
"parameters": [
{
"description": "Artist id",
"example": "1566",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "ISO 3166-1 alpha-2 country code",
"example": "US",
"in": "query",
"name": "countryCode",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: similarArtists",
"example": "similarArtists",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "similarArtists"
}
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Artists_Multi_Relationship_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Client_Credentials": []
},
{
"Authorization_Code_PKCE": []
}
],
"summary": "Get similarArtists relationship (\"to-many\").",
"tags": ["artists"],
"x-path-item-properties": {
"required-access-tier": "THIRD_PARTY"
}
}
},
"/artists/{id}/relationships/trackProviders": {
"get": {
"operationId": "getArtistTrackProviders",
"description": "Retrieves trackProviders relationship.",
"parameters": [
{
"description": "Artist id",
"example": "1566",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: trackProviders",
"example": "trackProviders",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "trackProviders"
}
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Artists_TrackProviders_Multi_Relationship_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Client_Credentials": []
},
{
"Authorization_Code_PKCE": []
}
],
"summary": "Get trackProviders relationship (\"to-many\").",
"tags": ["artists"],
"x-path-item-properties": {
"required-access-tier": "THIRD_PARTY"
}
}
},
"/artists/{id}/relationships/tracks": {
"get": {
"operationId": "getArtistTracks",
"description": "Retrieves tracks relationship.",
"parameters": [
{
"description": "Artist id",
"example": "1566",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Collapse by options for getting artist tracks. Available options: FINGERPRINT, ID. FINGERPRINT option might collapse similar tracks based entry fingerprints while collapsing by ID always returns all available items.",
"example": "FINGERPRINT",
"in": "query",
"name": "collapseBy",
"required": true,
"schema": {
"type": "string",
"enum": ["FINGERPRINT", "NONE"]
}
},
{
"description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "ISO 3166-1 alpha-2 country code",
"example": "US",
"in": "query",
"name": "countryCode",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: tracks",
"example": "tracks",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "tracks"
}
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Artists_Multi_Relationship_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Client_Credentials": []
},
{
"Authorization_Code_PKCE": []
}
],
"summary": "Get tracks relationship (\"to-many\").",
"tags": ["artists"],
"x-path-item-properties": {
"required-access-tier": "THIRD_PARTY"
}
}
},
"/artists/{id}/relationships/videos": {
"get": {
"operationId": "getArtistVideos",
"description": "Retrieves videos relationship.",
"parameters": [
{
"description": "Artist id",
"example": "1566",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "ISO 3166-1 alpha-2 country code",
"example": "US",
"in": "query",
"name": "countryCode",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: videos",
"example": "videos",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "videos"
}
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Artists_Multi_Relationship_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Client_Credentials": []
},
{
"Authorization_Code_PKCE": []
}
],
"summary": "Get videos relationship (\"to-many\").",
"tags": ["artists"],
"x-path-item-properties": {
"required-access-tier": "THIRD_PARTY"
}
}
},
"/artworks": {
"get": {
"operationId": "getArtworks",
"description": "Retrieves multiple artworks by available filters, or without if applicable.",
"parameters": [
{
"description": "ISO 3166-1 alpha-2 country code",
"example": "US",
"in": "query",
"name": "countryCode",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: owners",
"example": "owners",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "owners"
}
}
},
{
"description": "Artwork id",
"example": "a468bee88def",
"in": "query",
"name": "filter[id]",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "a468bee88def"
}
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Artworks_Multi_Resource_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Client_Credentials": []
},
{
"Authorization_Code_PKCE": []
}
],
"summary": "Get multiple artworks.",
"tags": ["artworks"],
"x-path-item-properties": {
"required-access-tier": "THIRD_PARTY"
}
},
"post": {
"operationId": "createArtwork",
"description": "Creates a new artwork.",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ArtworkCreateOperation_Payload"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Artworks_Single_Resource_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["w_usr"]
}
],
"summary": "Create single artwork.",
"tags": ["artworks"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
}
},
"/artworks/{id}": {
"get": {
"operationId": "getArtwork",
"description": "Retrieves single artwork by id.",
"parameters": [
{
"description": "Artwork id",
"example": "a468bee88def",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "ISO 3166-1 alpha-2 country code",
"example": "US",
"in": "query",
"name": "countryCode",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: owners",
"example": "owners",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "owners"
}
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Artworks_Single_Resource_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Client_Credentials": []
},
{
"Authorization_Code_PKCE": []
}
],
"summary": "Get single artwork.",
"tags": ["artworks"],
"x-path-item-properties": {
"required-access-tier": "THIRD_PARTY"
}
}
},
"/artworks/{id}/relationships/owners": {
"get": {
"operationId": "getArtworkOwners",
"description": "Retrieves owners relationship.",
"parameters": [
{
"description": "Artwork id",
"example": "a468bee88def",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: owners",
"example": "owners",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "owners"
}
}
},
{
"description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Artworks_Multi_Relationship_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Client_Credentials": []
},
{
"Authorization_Code_PKCE": []
}
],
"summary": "Get owners relationship (\"to-many\").",
"tags": ["artworks"],
"x-path-item-properties": {
"required-access-tier": "THIRD_PARTY"
}
}
},
"/dynamicPages": {
"get": {
"operationId": "getDynamicPage",
"description": "Retrieves multiple dynamicPages by available filters, or without if applicable.",
"parameters": [
{
"in": "query",
"name": "clientVersion",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "The type of device making the request",
"example": "PHONE",
"in": "query",
"name": "deviceType",
"required": true,
"schema": {
"type": "string",
"enum": ["BROWSER", "CAR", "DESKTOP", "PHONE", "TABLET", "TV"]
}
},
{
"description": "The platform of the device making the request",
"example": "IOS",
"in": "query",
"name": "platform",
"required": true,
"schema": {
"type": "string",
"enum": ["ANDROID", "DESKTOP", "TESLA", "IOS", "WEB"]
}
},
{
"in": "query",
"name": "refreshId",
"required": false,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"description": "ISO 3166-1 alpha-2 country code",
"example": "US",
"in": "query",
"name": "countryCode",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported.",
"example": "en-US",
"in": "query",
"name": "locale",
"required": false,
"schema": {
"type": "string",
"default": "en-US"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: subject",
"example": "subject",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "subject"
}
}
},
{
"description": "Filter by page type",
"example": "ARTIST",
"in": "query",
"name": "filter[pageType]",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "ARTIST"
}
}
},
{
"description": "Filter by subject id",
"example": "67890",
"in": "query",
"name": "filter[subject.id]",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "67890"
}
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DynamicPages_Multi_Resource_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Client_Credentials": []
},
{
"Authorization_Code_PKCE": []
}
],
"summary": "Get multiple dynamicPages.",
"tags": ["dynamicPages"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
}
},
"/dynamicPages/{id}/relationships/subject": {
"get": {
"operationId": "getDynamicPagesSubject",
"description": "Retrieves subject relationship.",
"parameters": [
{
"description": "DynamicPages Id",
"example": "nejMcAhh5N8S3EQ4LaqysVdI0cZZ",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: subject",
"example": "subject",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "subject"
}
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DynamicPages_Single_Relationship_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Client_Credentials": []
},
{
"Authorization_Code_PKCE": ["r_usr"]
}
],
"summary": "Get subject relationship (\"to-one\").",
"tags": ["dynamicPages"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
}
},
"/genres": {
"get": {
"operationId": "getGenres",
"description": "Retrieves multiple genres by available filters, or without if applicable.",
"parameters": [
{
"description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported.",
"example": "en-US",
"in": "query",
"name": "locale",
"required": false,
"schema": {
"type": "string",
"default": "en-US"
}
},
{
"description": "Allows filtering by genre id(s). USER_SELECTABLE is special value used to return specific genres which users can select from",
"example": "'1,2,3' or 'USER_SELECTABLE'",
"in": "query",
"name": "filter[id]",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "'1,2,3' or 'USER_SELECTABLE'"
}
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Genres_Multi_Resource_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Client_Credentials": []
},
{
"Authorization_Code_PKCE": []
}
],
"summary": "Get multiple genres.",
"tags": ["genres"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
}
},
"/genres/{id}": {
"get": {
"operationId": "getGenre",
"description": "Retrieves single genre by id.",
"parameters": [
{
"description": "Genre id",
"example": "123",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported.",
"example": "en-US",
"in": "query",
"name": "locale",
"required": false,
"schema": {
"type": "string",
"default": "en-US"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Genres_Single_Resource_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Client_Credentials": []
},
{
"Authorization_Code_PKCE": []
}
],
"summary": "Get single genre.",
"tags": ["genres"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
}
},
"/lyrics": {
"get": {
"operationId": "getLyrics",
"description": "Retrieves multiple lyrics by available filters, or without if applicable.",
"parameters": [
{
"description": "Allows the client to customize which related resources should be returned. Available options: owners, track",
"example": "owners",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "owners"
}
}
},
{
"description": "Lyrics Id",
"example": "nejMcAhh5N8S3EQ4LaqysVdI0cZZ",
"in": "query",
"name": "filter[id]",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "nejMcAhh5N8S3EQ4LaqysVdI0cZZ"
}
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Lyrics_Multi_Resource_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Client_Credentials": []
},
{
"Authorization_Code_PKCE": []
}
],
"summary": "Get multiple lyrics.",
"tags": ["lyrics"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
},
"post": {
"operationId": "createLyric",
"description": "Creates a new lyric.",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LyricsCreateOperation_Payload"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Lyrics_Single_Resource_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["w_usr"]
}
],
"summary": "Create single lyric.",
"tags": ["lyrics"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
}
},
"/lyrics/{id}": {
"delete": {
"operationId": "deleteLyric",
"description": "Deletes existing lyric.",
"parameters": [
{
"description": "Lyrics Id",
"example": "nejMcAhh5N8S3EQ4LaqysVdI0cZZ",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": []
}
],
"summary": "Delete single lyric.",
"tags": ["lyrics"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
},
"get": {
"operationId": "getLyric",
"description": "Retrieves single lyric by id.",
"parameters": [
{
"description": "Lyrics Id",
"example": "nejMcAhh5N8S3EQ4LaqysVdI0cZZ",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: owners, track",
"example": "owners",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "owners"
}
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Lyrics_Single_Resource_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Client_Credentials": []
},
{
"Authorization_Code_PKCE": []
}
],
"summary": "Get single lyric.",
"tags": ["lyrics"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
},
"patch": {
"operationId": "patchLyric",
"description": "Updates existing lyric.",
"parameters": [
{
"description": "Lyrics Id",
"example": "nejMcAhh5N8S3EQ4LaqysVdI0cZZ",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LyricsUpdateOperation_Payload"
}
}
}
},
"responses": {
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["w_usr"]
}
],
"summary": "Update single lyric.",
"tags": ["lyrics"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
}
},
"/lyrics/{id}/relationships/owners": {
"get": {
"operationId": "getLyricOwners",
"description": "Retrieves owners relationship.",
"parameters": [
{
"description": "Lyrics Id",
"example": "nejMcAhh5N8S3EQ4LaqysVdI0cZZ",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "ISO 3166-1 alpha-2 country code",
"example": "US",
"in": "query",
"name": "countryCode",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: owners",
"example": "owners",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "owners"
}
}
},
{
"description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Lyrics_Multi_Relationship_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Client_Credentials": []
},
{
"Authorization_Code_PKCE": []
}
],
"summary": "Get owners relationship (\"to-many\").",
"tags": ["lyrics"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
}
},
"/lyrics/{id}/relationships/track": {
"get": {
"operationId": "getLyricTrack",
"description": "Retrieves track relationship.",
"parameters": [
{
"description": "Lyrics Id",
"example": "nejMcAhh5N8S3EQ4LaqysVdI0cZZ",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "ISO 3166-1 alpha-2 country code",
"example": "US",
"in": "query",
"name": "countryCode",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: track",
"example": "track",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "track"
}
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Lyrics_Single_Relationship_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Client_Credentials": []
},
{
"Authorization_Code_PKCE": []
}
],
"summary": "Get track relationship (\"to-one\").",
"tags": ["lyrics"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
}
},
"/manualArtistClaims": {
"post": {
"operationId": "createManualArtistClaim",
"description": "Creates a new manualArtistClaim.",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManualArtistClaimsCreateOperation_Payload"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManualArtistClaims_Single_Resource_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["w_usr"]
}
],
"summary": "Create single manualArtistClaim.",
"tags": ["manualArtistClaims"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
}
},
"/playQueues": {
"get": {
"operationId": "getPlayQueues",
"description": "Retrieves multiple playQueues by available filters, or without if applicable.",
"parameters": [
{
"description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: current, future, owners, past",
"example": "current",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "current"
}
}
},
{
"description": "User id",
"example": "123456",
"in": "query",
"name": "filter[owners.id]",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "123456"
}
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PlayQueues_Multi_Resource_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["r_usr"]
}
],
"summary": "Get multiple playQueues.",
"tags": ["playQueues"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
},
"post": {
"operationId": "createPlayQueue",
"description": "Creates a new playQueue.",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PlayQueueCreateOperation_Payload"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PlayQueues_Single_Resource_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["w_usr"]
}
],
"summary": "Create single playQueue.",
"tags": ["playQueues"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
}
},
"/playQueues/{id}": {
"delete": {
"operationId": "deletePlayQueue",
"description": "Deletes existing playQueue.",
"parameters": [
{
"description": "Play queue id",
"example": "550e8400-e29b-41d4-a716-446655440000",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["w_usr"]
}
],
"summary": "Delete single playQueue.",
"tags": ["playQueues"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
},
"get": {
"operationId": "getPlayQueue",
"description": "Retrieves single playQueue by id.",
"parameters": [
{
"description": "Play queue id",
"example": "550e8400-e29b-41d4-a716-446655440000",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: current, future, owners, past",
"example": "current",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "current"
}
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PlayQueues_Single_Resource_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["r_usr"]
}
],
"summary": "Get single playQueue.",
"tags": ["playQueues"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
},
"patch": {
"operationId": "patchPlayQueue",
"description": "Updates existing playQueue.",
"parameters": [
{
"description": "Play queue id",
"example": "550e8400-e29b-41d4-a716-446655440000",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PlayQueueUpdateOperation_Payload"
}
}
}
},
"responses": {
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["w_usr"]
}
],
"summary": "Update single playQueue.",
"tags": ["playQueues"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
}
},
"/playQueues/{id}/relationships/current": {
"get": {
"operationId": "getCurrentPlayQueue",
"description": "Retrieves current relationship.",
"parameters": [
{
"description": "Play queue id",
"example": "550e8400-e29b-41d4-a716-446655440000",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: current",
"example": "current",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "current"
}
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PlayQueues_Current_Single_Relationship_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["r_usr"]
}
],
"summary": "Get current relationship (\"to-one\").",
"tags": ["playQueues"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
},
"patch": {
"operationId": "patchCurrentPlayQueue",
"description": "Updates current relationship.",
"parameters": [
{
"description": "Play queue id",
"example": "550e8400-e29b-41d4-a716-446655440000",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PlayQueueUpdateCurrentOperations_Payload"
}
}
}
},
"responses": {
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["w_usr"]
}
],
"summary": "Update current relationship (\"to-one\").",
"tags": ["playQueues"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
}
},
"/playQueues/{id}/relationships/future": {
"delete": {
"operationId": "deleteFuturePlayQueues",
"description": "Deletes item(s) from future relationship.",
"parameters": [
{
"description": "Play queue id",
"example": "550e8400-e29b-41d4-a716-446655440000",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PlayQueueRemoveFutureOperation_Payload"
}
}
}
},
"responses": {
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["w_usr"]
}
],
"summary": "Delete from future relationship (\"to-many\").",
"tags": ["playQueues"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
},
"get": {
"operationId": "getFuturePlayQueue",
"description": "Retrieves future relationship.",
"parameters": [
{
"description": "Play queue id",
"example": "550e8400-e29b-41d4-a716-446655440000",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: future",
"example": "future",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "future"
}
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PlayQueues_Future_Multi_Relationship_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["r_usr"]
}
],
"summary": "Get future relationship (\"to-many\").",
"tags": ["playQueues"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
},
"patch": {
"operationId": "patchFuturePlayQueue",
"description": "Updates future relationship.",
"parameters": [
{
"description": "Play queue id",
"example": "550e8400-e29b-41d4-a716-446655440000",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PlayQueueUpdateFutureOperation_Payload"
}
}
}
},
"responses": {
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["w_usr"]
}
],
"summary": "Update future relationship (\"to-many\").",
"tags": ["playQueues"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
},
"post": {
"operationId": "createFuturePlayQueue",
"description": "Adds item(s) to future relationship.",
"parameters": [
{
"description": "Play queue id",
"example": "550e8400-e29b-41d4-a716-446655440000",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PlayQueueAddFutureOperation_Payload"
}
}
}
},
"responses": {
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["w_usr"]
}
],
"summary": "Add to future relationship (\"to-many\").",
"tags": ["playQueues"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
}
},
"/playQueues/{id}/relationships/owners": {
"get": {
"operationId": "getPlayQueueOwners",
"description": "Retrieves owners relationship.",
"parameters": [
{
"description": "Play queue id",
"example": "550e8400-e29b-41d4-a716-446655440000",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: owners",
"example": "owners",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "owners"
}
}
},
{
"description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PlayQueues_Multi_Relationship_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["r_usr"]
}
],
"summary": "Get owners relationship (\"to-many\").",
"tags": ["playQueues"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
}
},
"/playQueues/{id}/relationships/past": {
"get": {
"operationId": "getPastPlayQueues",
"description": "Retrieves past relationship.",
"parameters": [
{
"description": "Play queue id",
"example": "550e8400-e29b-41d4-a716-446655440000",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: past",
"example": "past",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "past"
}
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PlayQueues_Past_Multi_Relationship_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["r_usr"]
}
],
"summary": "Get past relationship (\"to-many\").",
"tags": ["playQueues"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
}
},
"/playlists": {
"get": {
"operationId": "getPlaylists",
"description": "Retrieves multiple playlists by available filters, or without if applicable.",
"parameters": [
{
"description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Values prefixed with \"-\" are sorted descending; values without it are sorted ascending.",
"in": "query",
"name": "sort",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "createdAt",
"enum": [
"createdAt",
"-createdAt",
"lastModifiedAt",
"-lastModifiedAt",
"name",
"-name"
],
"default": "-createdAt",
"x-enum-varnames": [
"CreatedAtAsc",
"CreatedAtDesc",
"LastModifiedAtAsc",
"LastModifiedAtDesc",
"NameAsc",
"NameDesc"
]
}
}
},
{
"description": "ISO 3166-1 alpha-2 country code",
"example": "US",
"in": "query",
"name": "countryCode",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: coverArt, items, ownerProfiles, owners",
"example": "coverArt",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "coverArt"
}
}
},
{
"description": "Playlist id",
"example": "550e8400-e29b-41d4-a716-446655440000",
"in": "query",
"name": "filter[id]",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "550e8400-e29b-41d4-a716-446655440000"
}
}
},
{
"description": "User id",
"example": "123456",
"in": "query",
"name": "filter[owners.id]",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "123456"
}
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Playlists_Multi_Resource_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Client_Credentials": []
},
{
"Authorization_Code_PKCE": ["playlists.read", "r_usr"]
}
],
"summary": "Get multiple playlists.",
"tags": ["playlists"],
"x-path-item-properties": {
"required-access-tier": "THIRD_PARTY"
}
},
"post": {
"operationId": "createPlaylist",
"description": "Creates a new playlist.",
"parameters": [
{
"description": "ISO 3166-1 alpha-2 country code",
"example": "US",
"in": "query",
"name": "countryCode",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PlaylistCreateOperation_Payload"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Playlists_Single_Resource_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["playlists.write", "w_usr"]
}
],
"summary": "Create single playlist.",
"tags": ["playlists"],
"x-path-item-properties": {
"required-access-tier": "THIRD_PARTY"
}
}
},
"/playlists/{id}": {
"delete": {
"operationId": "deletePlaylist",
"description": "Deletes existing playlist.",
"parameters": [
{
"description": "Playlist id",
"example": "550e8400-e29b-41d4-a716-446655440000",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["playlists.write", "w_usr"]
}
],
"summary": "Delete single playlist.",
"tags": ["playlists"],
"x-path-item-properties": {
"required-access-tier": "THIRD_PARTY"
}
},
"get": {
"operationId": "getPlaylist",
"description": "Retrieves single playlist by id.",
"parameters": [
{
"description": "Playlist id",
"example": "550e8400-e29b-41d4-a716-446655440000",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "ISO 3166-1 alpha-2 country code",
"example": "US",
"in": "query",
"name": "countryCode",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: coverArt, items, ownerProfiles, owners",
"example": "coverArt",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "coverArt"
}
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Playlists_Single_Resource_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Client_Credentials": []
},
{
"Authorization_Code_PKCE": []
}
],
"summary": "Get single playlist.",
"tags": ["playlists"],
"x-path-item-properties": {
"required-access-tier": "THIRD_PARTY"
}
},
"patch": {
"operationId": "patchPlaylist",
"description": "Updates existing playlist.",
"parameters": [
{
"description": "Playlist id",
"example": "550e8400-e29b-41d4-a716-446655440000",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "ISO 3166-1 alpha-2 country code",
"example": "US",
"in": "query",
"name": "countryCode",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PlaylistUpdateOperation_Payload"
}
}
}
},
"responses": {
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["playlists.write", "w_usr"]
}
],
"summary": "Update single playlist.",
"tags": ["playlists"],
"x-path-item-properties": {
"required-access-tier": "THIRD_PARTY"
}
}
},
"/playlists/{id}/relationships/coverArt": {
"get": {
"operationId": "getPlaylistCoverArt",
"description": "Retrieves coverArt relationship.",
"parameters": [
{
"description": "Playlist id",
"example": "550e8400-e29b-41d4-a716-446655440000",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "ISO 3166-1 alpha-2 country code",
"example": "US",
"in": "query",
"name": "countryCode",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: coverArt",
"example": "coverArt",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "coverArt"
}
}
},
{
"description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Playlists_Multi_Relationship_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Client_Credentials": []
},
{
"Authorization_Code_PKCE": []
}
],
"summary": "Get coverArt relationship (\"to-many\").",
"tags": ["playlists"],
"x-path-item-properties": {
"required-access-tier": "THIRD_PARTY"
}
},
"patch": {
"operationId": "patchPlaylistCoverArt",
"description": "Updates coverArt relationship.",
"parameters": [
{
"description": "Playlist id",
"example": "550e8400-e29b-41d4-a716-446655440000",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PlaylistCoverArtRelationshipUpdateOperation_Payload"
}
}
}
},
"responses": {
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["playlists.write", "w_usr"]
}
],
"summary": "Update coverArt relationship (\"to-many\").",
"tags": ["playlists"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
}
},
"/playlists/{id}/relationships/items": {
"delete": {
"operationId": "deletePlaylistItems",
"description": "Deletes item(s) from items relationship.",
"parameters": [
{
"description": "Playlist id",
"example": "550e8400-e29b-41d4-a716-446655440000",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PlaylistItemsRelationshipRemoveOperation_Payload"
}
}
}
},
"responses": {
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["playlists.write", "w_usr"]
}
],
"summary": "Delete from items relationship (\"to-many\").",
"tags": ["playlists"],
"x-path-item-properties": {
"required-access-tier": "THIRD_PARTY"
}
},
"get": {
"operationId": "getPlaylistItems",
"description": "Retrieves items relationship.",
"parameters": [
{
"description": "Playlist id",
"example": "550e8400-e29b-41d4-a716-446655440000",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "ISO 3166-1 alpha-2 country code",
"example": "US",
"in": "query",
"name": "countryCode",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: items",
"example": "items",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "items"
}
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Playlists_Items_Multi_Relationship_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Client_Credentials": []
},
{
"Authorization_Code_PKCE": []
}
],
"summary": "Get items relationship (\"to-many\").",
"tags": ["playlists"],
"x-path-item-properties": {
"required-access-tier": "THIRD_PARTY"
}
},
"patch": {
"operationId": "patchPlaylistItems",
"description": "Updates items relationship.",
"parameters": [
{
"description": "Playlist id",
"example": "550e8400-e29b-41d4-a716-446655440000",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PlaylistItemsRelationshipReorderOperation_Payload"
}
}
}
},
"responses": {
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["playlists.write", "w_usr"]
}
],
"summary": "Update items relationship (\"to-many\").",
"tags": ["playlists"],
"x-path-item-properties": {
"required-access-tier": "THIRD_PARTY"
}
},
"post": {
"operationId": "addItemsToPlaylist",
"description": "Adds item(s) to items relationship.",
"parameters": [
{
"description": "Playlist id",
"example": "550e8400-e29b-41d4-a716-446655440000",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "ISO 3166-1 alpha-2 country code",
"example": "US",
"in": "query",
"name": "countryCode",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PlaylistItemsRelationshipAddOperation_Payload"
}
}
}
},
"responses": {
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["playlists.write", "w_usr"]
}
],
"summary": "Add to items relationship (\"to-many\").",
"tags": ["playlists"],
"x-path-item-properties": {
"required-access-tier": "THIRD_PARTY"
}
}
},
"/playlists/{id}/relationships/ownerProfiles": {
"get": {
"operationId": "getPlaylistOwnerProfiles",
"description": "Retrieves ownerProfiles relationship.",
"parameters": [
{
"description": "Playlist id",
"example": "550e8400-e29b-41d4-a716-446655440000",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "ISO 3166-1 alpha-2 country code",
"example": "US",
"in": "query",
"name": "countryCode",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: ownerProfiles",
"example": "ownerProfiles",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "ownerProfiles"
}
}
},
{
"description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Playlists_Multi_Relationship_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Client_Credentials": []
},
{
"Authorization_Code_PKCE": []
}
],
"summary": "Get ownerProfiles relationship (\"to-many\").",
"tags": ["playlists"],
"x-path-item-properties": {
"required-access-tier": "THIRD_PARTY"
}
}
},
"/playlists/{id}/relationships/owners": {
"get": {
"operationId": "getPlaylistOwners",
"description": "Retrieves owners relationship.",
"parameters": [
{
"description": "Playlist id",
"example": "550e8400-e29b-41d4-a716-446655440000",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "ISO 3166-1 alpha-2 country code",
"example": "US",
"in": "query",
"name": "countryCode",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: owners",
"example": "owners",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "owners"
}
}
},
{
"description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Playlists_Multi_Relationship_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Client_Credentials": []
},
{
"Authorization_Code_PKCE": []
}
],
"summary": "Get owners relationship (\"to-many\").",
"tags": ["playlists"],
"x-path-item-properties": {
"required-access-tier": "THIRD_PARTY"
}
}
},
"/providers": {
"get": {
"operationId": "getProviders",
"description": "Retrieves multiple providers by available filters, or without if applicable.",
"parameters": [
{
"description": "Provider ID",
"example": "12345",
"in": "query",
"name": "filter[id]",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "12345"
}
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Providers_Multi_Resource_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Client_Credentials": []
},
{
"Authorization_Code_PKCE": []
}
],
"summary": "Get multiple providers.",
"tags": ["providers"],
"x-path-item-properties": {
"required-access-tier": "THIRD_PARTY"
}
}
},
"/providers/{id}": {
"get": {
"operationId": "getProvider",
"description": "Retrieves single provider by id.",
"parameters": [
{
"description": "Provider ID",
"example": "12345",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Providers_Single_Resource_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Client_Credentials": []
},
{
"Authorization_Code_PKCE": []
}
],
"summary": "Get single provider.",
"tags": ["providers"],
"x-path-item-properties": {
"required-access-tier": "THIRD_PARTY"
}
}
},
"/reactions": {
"get": {
"operationId": "getReactions",
"description": "Retrieves multiple reactions by available filters, or without if applicable.",
"parameters": [
{
"in": "query",
"name": "stats",
"required": false,
"schema": {
"type": "string",
"enum": ["ALL", "COUNTS_BY_TYPE", "TOTAL_COUNT"]
}
},
{
"in": "query",
"name": "statsOnly",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: ownerProfiles",
"example": "ownerProfiles",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "ownerProfiles"
}
}
},
{
"description": "Filter by owner id",
"example": "67890",
"in": "query",
"name": "filter[owner.id]",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "67890"
}
}
},
{
"description": "Filter by resource ID",
"example": "12345",
"in": "query",
"name": "filter[reactedResource.id]",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "12345"
}
}
},
{
"description": "Filter by resource type",
"example": "albums",
"in": "query",
"name": "filter[reactedResource.type]",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "albums"
}
}
},
{
"description": "Filter by reaction type",
"example": "FIRE",
"in": "query",
"name": "filter[reactionType]",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "FIRE"
}
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Reactions_Multi_Resource_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": []
}
],
"summary": "Get multiple reactions.",
"tags": ["reactions"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
},
"post": {
"operationId": "createReaction",
"description": "Creates a new reaction.",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateReactionPayload"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Reactions_Single_Resource_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["w_usr"]
}
],
"summary": "Create single reaction.",
"tags": ["reactions"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
}
},
"/reactions/{id}": {
"delete": {
"operationId": "deleteReaction",
"description": "Deletes existing reaction.",
"parameters": [
{
"description": "Reaction Id",
"example": "nejMcAhh5N8S3EQ4LaqysVdI0cZZ",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["w_usr"]
}
],
"summary": "Delete single reaction.",
"tags": ["reactions"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
}
},
"/reactions/{id}/relationships/ownerProfiles": {
"get": {
"operationId": "getReactionOwnerProfile",
"description": "Retrieves ownerProfiles relationship.",
"parameters": [
{
"description": "Reaction Id",
"example": "nejMcAhh5N8S3EQ4LaqysVdI0cZZ",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: ownerProfiles",
"example": "ownerProfiles",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "ownerProfiles"
}
}
},
{
"description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Reactions_Multi_Relationship_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": []
}
],
"summary": "Get ownerProfiles relationship (\"to-many\").",
"tags": ["reactions"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
}
},
"/savedShares": {
"post": {
"operationId": "createSavedShare",
"description": "Creates a new savedShare.",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SavedSharesCreateOperation_Payload"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SavedShares_Single_Resource_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["w_usr"]
}
],
"summary": "Create single savedShare.",
"tags": ["savedShares"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
}
},
"/searchResults/{id}": {
"get": {
"operationId": "getSearchResult",
"description": "Retrieves single searchResult by id.",
"parameters": [
{
"description": "Search query string used as the resource identifier",
"example": "hello",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Explicit filter",
"example": "INCLUDE/EXCLUDE",
"in": "query",
"name": "explicitFilter",
"required": false,
"schema": {
"type": "string",
"enum": ["INCLUDE", "EXCLUDE"],
"default": "INCLUDE"
}
},
{
"description": "ISO 3166-1 alpha-2 country code",
"example": "US",
"in": "query",
"name": "countryCode",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: albums, artists, playlists, topHits, tracks, videos",
"example": "albums",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "albums"
}
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SearchResults_Single_Resource_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Client_Credentials": []
},
{
"Authorization_Code_PKCE": ["r_usr", "search.read"]
}
],
"summary": "Get single searchResult.",
"tags": ["searchResults"],
"x-path-item-properties": {
"required-access-tier": "THIRD_PARTY"
}
}
},
"/searchResults/{id}/relationships/albums": {
"get": {
"operationId": "getSearchResultAlbums",
"description": "Retrieves albums relationship.",
"parameters": [
{
"description": "Search query string used as the resource identifier",
"example": "hello",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Explicit filter",
"example": "INCLUDE/EXCLUDE",
"in": "query",
"name": "explicitFilter",
"required": false,
"schema": {
"type": "string",
"enum": ["INCLUDE", "EXCLUDE"],
"default": "INCLUDE"
}
},
{
"description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "ISO 3166-1 alpha-2 country code",
"example": "US",
"in": "query",
"name": "countryCode",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: albums",
"example": "albums",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "albums"
}
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SearchResults_Multi_Relationship_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Client_Credentials": []
},
{
"Authorization_Code_PKCE": ["r_usr", "search.read"]
}
],
"summary": "Get albums relationship (\"to-many\").",
"tags": ["searchResults"],
"x-path-item-properties": {
"required-access-tier": "THIRD_PARTY"
}
}
},
"/searchResults/{id}/relationships/artists": {
"get": {
"operationId": "getSearchResultArtists",
"description": "Retrieves artists relationship.",
"parameters": [
{
"description": "Search query string used as the resource identifier",
"example": "hello",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Explicit filter",
"example": "INCLUDE/EXCLUDE",
"in": "query",
"name": "explicitFilter",
"required": false,
"schema": {
"type": "string",
"enum": ["INCLUDE", "EXCLUDE"],
"default": "INCLUDE"
}
},
{
"description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "ISO 3166-1 alpha-2 country code",
"example": "US",
"in": "query",
"name": "countryCode",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: artists",
"example": "artists",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "artists"
}
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SearchResults_Multi_Relationship_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Client_Credentials": []
},
{
"Authorization_Code_PKCE": ["r_usr", "search.read"]
}
],
"summary": "Get artists relationship (\"to-many\").",
"tags": ["searchResults"],
"x-path-item-properties": {
"required-access-tier": "THIRD_PARTY"
}
}
},
"/searchResults/{id}/relationships/playlists": {
"get": {
"operationId": "getSearchResultPlaylists",
"description": "Retrieves playlists relationship.",
"parameters": [
{
"description": "Search query string used as the resource identifier",
"example": "hello",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Explicit filter",
"example": "INCLUDE/EXCLUDE",
"in": "query",
"name": "explicitFilter",
"required": false,
"schema": {
"type": "string",
"enum": ["INCLUDE", "EXCLUDE"],
"default": "INCLUDE"
}
},
{
"description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "ISO 3166-1 alpha-2 country code",
"example": "US",
"in": "query",
"name": "countryCode",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: playlists",
"example": "playlists",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "playlists"
}
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SearchResults_Multi_Relationship_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Client_Credentials": []
},
{
"Authorization_Code_PKCE": ["r_usr", "search.read"]
}
],
"summary": "Get playlists relationship (\"to-many\").",
"tags": ["searchResults"],
"x-path-item-properties": {
"required-access-tier": "THIRD_PARTY"
}
}
},
"/searchResults/{id}/relationships/topHits": {
"get": {
"operationId": "getSearchResultsTopHits",
"description": "Retrieves topHits relationship.",
"parameters": [
{
"description": "Search query string used as the resource identifier",
"example": "hello",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Explicit filter",
"example": "INCLUDE/EXCLUDE",
"in": "query",
"name": "explicitFilter",
"required": false,
"schema": {
"type": "string",
"enum": ["INCLUDE", "EXCLUDE"],
"default": "INCLUDE"
}
},
{
"description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "ISO 3166-1 alpha-2 country code",
"example": "US",
"in": "query",
"name": "countryCode",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: topHits",
"example": "topHits",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "topHits"
}
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SearchResults_Multi_Relationship_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Client_Credentials": []
},
{
"Authorization_Code_PKCE": ["r_usr", "search.read"]
}
],
"summary": "Get topHits relationship (\"to-many\").",
"tags": ["searchResults"],
"x-path-item-properties": {
"required-access-tier": "THIRD_PARTY"
}
}
},
"/searchResults/{id}/relationships/tracks": {
"get": {
"operationId": "getSearchResultTracks",
"description": "Retrieves tracks relationship.",
"parameters": [
{
"description": "Search query string used as the resource identifier",
"example": "hello",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Explicit filter",
"example": "INCLUDE/EXCLUDE",
"in": "query",
"name": "explicitFilter",
"required": false,
"schema": {
"type": "string",
"enum": ["INCLUDE", "EXCLUDE"],
"default": "INCLUDE"
}
},
{
"description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "ISO 3166-1 alpha-2 country code",
"example": "US",
"in": "query",
"name": "countryCode",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: tracks",
"example": "tracks",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "tracks"
}
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SearchResults_Multi_Relationship_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Client_Credentials": []
},
{
"Authorization_Code_PKCE": ["r_usr", "search.read"]
}
],
"summary": "Get tracks relationship (\"to-many\").",
"tags": ["searchResults"],
"x-path-item-properties": {
"required-access-tier": "THIRD_PARTY"
}
}
},
"/searchResults/{id}/relationships/videos": {
"get": {
"operationId": "getSearchResultVideos",
"description": "Retrieves videos relationship.",
"parameters": [
{
"description": "Search query string used as the resource identifier",
"example": "hello",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Explicit filter",
"example": "INCLUDE/EXCLUDE",
"in": "query",
"name": "explicitFilter",
"required": false,
"schema": {
"type": "string",
"enum": ["INCLUDE", "EXCLUDE"],
"default": "INCLUDE"
}
},
{
"description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "ISO 3166-1 alpha-2 country code",
"example": "US",
"in": "query",
"name": "countryCode",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: videos",
"example": "videos",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "videos"
}
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SearchResults_Multi_Relationship_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Client_Credentials": []
},
{
"Authorization_Code_PKCE": ["r_usr", "search.read"]
}
],
"summary": "Get videos relationship (\"to-many\").",
"tags": ["searchResults"],
"x-path-item-properties": {
"required-access-tier": "THIRD_PARTY"
}
}
},
"/searchSuggestions/{id}": {
"get": {
"operationId": "getSearchSuggestion",
"description": "Retrieves single searchSuggestion by id.",
"parameters": [
{
"description": "Search query string used as the resource identifier",
"example": "hello",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Explicit filter",
"example": "INCLUDE/EXCLUDE",
"in": "query",
"name": "explicitFilter",
"required": false,
"schema": {
"type": "string",
"enum": ["INCLUDE", "EXCLUDE"],
"default": "INCLUDE"
}
},
{
"description": "ISO 3166-1 alpha-2 country code",
"example": "US",
"in": "query",
"name": "countryCode",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: directHits",
"example": "directHits",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "directHits"
}
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SearchSuggestions_Single_Resource_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Client_Credentials": []
},
{
"Authorization_Code_PKCE": []
}
],
"summary": "Get single searchSuggestion.",
"tags": ["searchSuggestions"],
"x-path-item-properties": {
"required-access-tier": "THIRD_PARTY"
}
}
},
"/searchSuggestions/{id}/relationships/directHits": {
"get": {
"operationId": "getSearchSuggestionDirectHits",
"description": "Retrieves directHits relationship.",
"parameters": [
{
"description": "Search query string used as the resource identifier",
"example": "hello",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Explicit filter",
"example": "INCLUDE/EXCLUDE",
"in": "query",
"name": "explicitFilter",
"required": false,
"schema": {
"type": "string",
"enum": ["INCLUDE", "EXCLUDE"],
"default": "INCLUDE"
}
},
{
"description": "ISO 3166-1 alpha-2 country code",
"example": "US",
"in": "query",
"name": "countryCode",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: directHits",
"example": "directHits",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "directHits"
}
}
},
{
"description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SearchSuggestions_Multi_Relationship_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Client_Credentials": []
},
{
"Authorization_Code_PKCE": []
}
],
"summary": "Get directHits relationship (\"to-many\").",
"tags": ["searchSuggestions"],
"x-path-item-properties": {
"required-access-tier": "THIRD_PARTY"
}
}
},
"/shares": {
"get": {
"operationId": "getShares",
"description": "Retrieves multiple shares by available filters, or without if applicable.",
"parameters": [
{
"description": "Allows the client to customize which related resources should be returned. Available options: owners, sharedResources",
"example": "owners",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "owners"
}
}
},
{
"description": "Share code",
"example": "xyz",
"in": "query",
"name": "filter[code]",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "xyz"
}
}
},
{
"description": "User share id",
"example": "a468bee88def",
"in": "query",
"name": "filter[id]",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "a468bee88def"
}
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Shares_Multi_Resource_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Client_Credentials": []
},
{
"Authorization_Code_PKCE": []
}
],
"summary": "Get multiple shares.",
"tags": ["shares"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
},
"post": {
"operationId": "createShare",
"description": "Creates a new share.",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SharesCreateOperation_Payload"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Shares_Single_Resource_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["w_usr"]
}
],
"summary": "Create single share.",
"tags": ["shares"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
}
},
"/shares/{id}": {
"get": {
"operationId": "getShare",
"description": "Retrieves single share by id.",
"parameters": [
{
"description": "User share id",
"example": "a468bee88def",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: owners, sharedResources",
"example": "owners",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "owners"
}
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Shares_Single_Resource_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Client_Credentials": []
},
{
"Authorization_Code_PKCE": []
}
],
"summary": "Get single share.",
"tags": ["shares"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
}
},
"/shares/{id}/relationships/owners": {
"get": {
"operationId": "getShareOwners",
"description": "Retrieves owners relationship.",
"parameters": [
{
"description": "User share id",
"example": "a468bee88def",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: owners",
"example": "owners",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "owners"
}
}
},
{
"description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Shares_Multi_Relationship_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Client_Credentials": []
},
{
"Authorization_Code_PKCE": []
}
],
"summary": "Get owners relationship (\"to-many\").",
"tags": ["shares"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
}
},
"/shares/{id}/relationships/sharedResources": {
"get": {
"operationId": "getShareSharedResources",
"description": "Retrieves sharedResources relationship.",
"parameters": [
{
"description": "User share id",
"example": "a468bee88def",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: sharedResources",
"example": "sharedResources",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "sharedResources"
}
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Shares_Multi_Relationship_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Client_Credentials": []
},
{
"Authorization_Code_PKCE": []
}
],
"summary": "Get sharedResources relationship (\"to-many\").",
"tags": ["shares"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
}
},
"/stripeConnections": {
"get": {
"operationId": "getStripeConnections",
"description": "Retrieves multiple stripeConnections by available filters, or without if applicable.",
"parameters": [
{
"description": "Allows the client to customize which related resources should be returned. Available options: owners",
"example": "owners",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "owners"
}
}
},
{
"description": "User id",
"example": "123456",
"in": "query",
"name": "filter[owners.id]",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "123456"
}
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StripeConnections_Multi_Resource_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["r_usr"]
}
],
"summary": "Get multiple stripeConnections.",
"tags": ["stripeConnections"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
},
"post": {
"operationId": "createStripeConnection",
"description": "Creates a new stripeConnection.",
"parameters": [
{
"description": "ISO 3166-1 alpha-2 country code",
"example": "US",
"in": "query",
"name": "countryCode",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StripeConnectionsCreateOperation_Payload"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StripeConnections_Single_Resource_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["w_usr"]
}
],
"summary": "Create single stripeConnection.",
"tags": ["stripeConnections"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
}
},
"/stripeConnections/{id}/relationships/owners": {
"get": {
"operationId": "getStripeConnectionOwners",
"description": "Retrieves owners relationship.",
"parameters": [
{
"description": "Stripe connection id (same as user id)",
"example": "39791222",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: owners",
"example": "owners",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "owners"
}
}
},
{
"description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StripeConnections_Multi_Relationship_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["r_usr"]
}
],
"summary": "Get owners relationship (\"to-many\").",
"tags": ["stripeConnections"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
}
},
"/trackFiles/{id}": {
"get": {
"operationId": "getTrackFile",
"description": "Retrieves single trackFile by id.",
"parameters": [
{
"description": "Track file id",
"example": "123456",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "formats",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": ["HEAACV1", "AACLC", "FLAC", "FLAC_HIRES", "EAC3_JOC"]
}
}
},
{
"in": "query",
"name": "usage",
"required": true,
"schema": {
"type": "string",
"enum": ["PLAYBACK", "DOWNLOAD"]
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TrackFiles_Single_Resource_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"403": {
"$ref": "#/components/responses/TrackFilesReadById403Response"
},
"404": {
"$ref": "#/components/responses/TrackFilesReadById404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Client_Credentials": []
},
{
"Authorization_Code_PKCE": ["playback", "r_usr"]
}
],
"summary": "Get single trackFile.",
"tags": ["trackFiles"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
}
},
"/trackManifests/{id}": {
"get": {
"operationId": "getTrackManifest",
"description": "Retrieves single trackManifest by id.",
"parameters": [
{
"description": "Track manifest id",
"example": "123456",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "manifestType",
"required": true,
"schema": {
"type": "string",
"enum": ["HLS", "MPEG_DASH"]
}
},
{
"in": "query",
"name": "formats",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": ["HEAACV1", "AACLC", "FLAC", "FLAC_HIRES", "EAC3_JOC"]
}
}
},
{
"in": "query",
"name": "uriScheme",
"required": true,
"schema": {
"type": "string",
"enum": ["HTTPS", "DATA"]
}
},
{
"in": "query",
"name": "usage",
"required": true,
"schema": {
"type": "string",
"enum": ["PLAYBACK", "DOWNLOAD"]
}
},
{
"in": "query",
"name": "adaptive",
"required": true,
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TrackManifests_Single_Resource_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"403": {
"$ref": "#/components/responses/TrackManifestsReadById403Response"
},
"404": {
"$ref": "#/components/responses/TrackManifestsReadById404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Client_Credentials": []
},
{
"Authorization_Code_PKCE": ["playback", "r_usr"]
}
],
"summary": "Get single trackManifest.",
"tags": ["trackManifests"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
}
},
"/trackSourceFiles": {
"get": {
"operationId": "getTrackSourceFiles",
"description": "Retrieves multiple trackSourceFiles by available filters, or without if applicable.",
"parameters": [
{
"description": "Allows the client to customize which related resources should be returned. Available options: owners",
"example": "owners",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "owners"
}
}
},
{
"description": "Track source file id",
"example": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11",
"in": "query",
"name": "filter[id]",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11"
}
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TrackSourceFiles_Multi_Resource_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["r_usr"]
}
],
"summary": "Get multiple trackSourceFiles.",
"tags": ["trackSourceFiles"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
},
"post": {
"operationId": "createTrackSourceFile",
"description": "Create a track source file. <p/>\nThe response contains a upload link that must be used to upload the actual content.<p/>\nThe headers in the upload link response must be sent doing the actual upload.\n",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TrackSourceFileCreateOperation_Payload"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TrackSourceFiles_Single_Resource_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["w_usr"]
}
],
"summary": "Create single trackSourceFile.",
"tags": ["trackSourceFiles"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
}
},
"/trackSourceFiles/{id}": {
"get": {
"operationId": "getTrackSourceFile",
"description": "Retrieves single trackSourceFile by id.",
"parameters": [
{
"description": "Track source file id",
"example": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: owners",
"example": "owners",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "owners"
}
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TrackSourceFiles_Single_Resource_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["r_usr"]
}
],
"summary": "Get single trackSourceFile.",
"tags": ["trackSourceFiles"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
}
},
"/trackSourceFiles/{id}/relationships/owners": {
"get": {
"operationId": "getTrackSourceFileOwners",
"description": "Retrieves owners relationship.",
"parameters": [
{
"description": "Track source file id",
"example": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: owners",
"example": "owners",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "owners"
}
}
},
{
"description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TrackSourceFiles_Multi_Relationship_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["r_usr"]
}
],
"summary": "Get owners relationship (\"to-many\").",
"tags": ["trackSourceFiles"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
}
},
"/trackStatistics": {
"get": {
"operationId": "getTrackStatistics",
"description": "Retrieves multiple trackStatistics by available filters, or without if applicable.",
"parameters": [
{
"description": "Allows the client to customize which related resources should be returned. Available options: owners",
"example": "owners",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "owners"
}
}
},
{
"description": "Track id",
"example": "75413016",
"in": "query",
"name": "filter[id]",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "75413016"
}
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TrackStatistics_Multi_Resource_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["r_usr"]
}
],
"summary": "Get multiple trackStatistics.",
"tags": ["trackStatistics"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
}
},
"/trackStatistics/{id}": {
"get": {
"operationId": "getTrackStatistic",
"description": "Retrieves single trackStatistic by id.",
"parameters": [
{
"description": "Track statistic id",
"example": "123456",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: owners",
"example": "owners",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "owners"
}
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TrackStatistics_Single_Resource_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["r_usr"]
}
],
"summary": "Get single trackStatistic.",
"tags": ["trackStatistics"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
}
},
"/trackStatistics/{id}/relationships/owners": {
"get": {
"operationId": "getTrackStatisticOwners",
"description": "Retrieves owners relationship.",
"parameters": [
{
"description": "Track statistic id",
"example": "123456",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: owners",
"example": "owners",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "owners"
}
}
},
{
"description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TrackStatistics_Multi_Relationship_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["r_usr"]
}
],
"summary": "Get owners relationship (\"to-many\").",
"tags": ["trackStatistics"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
}
},
"/tracks": {
"get": {
"operationId": "getTracks",
"description": "Retrieves multiple tracks by available filters, or without if applicable.",
"parameters": [
{
"description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "ISO 3166-1 alpha-2 country code",
"example": "US",
"in": "query",
"name": "countryCode",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: albums, artists, genres, lyrics, owners, providers, radio, replacement, shares, similarTracks, sourceFile, trackStatistics",
"example": "albums",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "albums"
}
}
},
{
"description": "Track id",
"example": "75413016",
"in": "query",
"name": "filter[id]",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "75413016"
}
}
},
{
"description": "International Standard Recording Code (ISRC)",
"example": "QMJMT1701237",
"in": "query",
"name": "filter[isrc]",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "QMJMT1701237"
}
}
},
{
"description": "User id",
"example": "123456",
"in": "query",
"name": "filter[owners.id]",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "123456"
}
}
},
{
"description": "Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted.",
"in": "query",
"name": "shareCode",
"required": false,
"schema": {
"type": "string",
"example": "xyz"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Tracks_Multi_Resource_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Client_Credentials": []
},
{
"Authorization_Code_PKCE": ["r_usr"]
}
],
"summary": "Get multiple tracks.",
"tags": ["tracks"],
"x-path-item-properties": {
"required-access-tier": "THIRD_PARTY"
}
},
"post": {
"operationId": "createTrack",
"description": "Creates a new track.",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TrackCreateOperation_Payload"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Tracks_Single_Resource_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["w_usr"]
}
],
"summary": "Create single track.",
"tags": ["tracks"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
}
},
"/tracks/{id}": {
"delete": {
"operationId": "deleteTrack",
"description": "Deletes existing track.",
"parameters": [
{
"description": "Track id",
"example": "75413016",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["w_usr"]
}
],
"summary": "Delete single track.",
"tags": ["tracks"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
},
"get": {
"operationId": "getTrack",
"description": "Retrieves single track by id.",
"parameters": [
{
"description": "Track id",
"example": "75413016",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "ISO 3166-1 alpha-2 country code",
"example": "US",
"in": "query",
"name": "countryCode",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: albums, artists, genres, lyrics, owners, providers, radio, replacement, shares, similarTracks, sourceFile, trackStatistics",
"example": "albums",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "albums"
}
}
},
{
"description": "Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted.",
"in": "query",
"name": "shareCode",
"required": false,
"schema": {
"type": "string",
"example": "xyz"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Tracks_Single_Resource_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Client_Credentials": []
},
{
"Authorization_Code_PKCE": []
}
],
"summary": "Get single track.",
"tags": ["tracks"],
"x-path-item-properties": {
"required-access-tier": "THIRD_PARTY"
}
},
"patch": {
"operationId": "patchTrack",
"description": "Updates existing track.",
"parameters": [
{
"description": "Track id",
"example": "75413016",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TrackUpdateOperation_Payload"
}
}
}
},
"responses": {
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["w_usr"]
}
],
"summary": "Update single track.",
"tags": ["tracks"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
}
},
"/tracks/{id}/relationships/albums": {
"get": {
"operationId": "getTrackAlbums",
"description": "Retrieves albums relationship.",
"parameters": [
{
"description": "Track id",
"example": "75413016",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "ISO 3166-1 alpha-2 country code",
"example": "US",
"in": "query",
"name": "countryCode",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: albums",
"example": "albums",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "albums"
}
}
},
{
"description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted.",
"in": "query",
"name": "shareCode",
"required": false,
"schema": {
"type": "string",
"example": "xyz"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Tracks_Multi_Relationship_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Client_Credentials": []
},
{
"Authorization_Code_PKCE": []
}
],
"summary": "Get albums relationship (\"to-many\").",
"tags": ["tracks"],
"x-path-item-properties": {
"required-access-tier": "THIRD_PARTY"
}
},
"patch": {
"operationId": "patchTrackAlbums",
"description": "Updates albums relationship.",
"parameters": [
{
"description": "Track id",
"example": "75413016",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TrackAlbumsRelationshipUpdateOperation_Payload"
}
}
}
},
"responses": {
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["w_usr"]
}
],
"summary": "Update albums relationship (\"to-many\").",
"tags": ["tracks"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
}
},
"/tracks/{id}/relationships/artists": {
"get": {
"operationId": "patchTrackArtists",
"description": "Retrieves artists relationship.",
"parameters": [
{
"description": "Track id",
"example": "75413016",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "ISO 3166-1 alpha-2 country code",
"example": "US",
"in": "query",
"name": "countryCode",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: artists",
"example": "artists",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "artists"
}
}
},
{
"description": "Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted.",
"in": "query",
"name": "shareCode",
"required": false,
"schema": {
"type": "string",
"example": "xyz"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Tracks_Multi_Relationship_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Client_Credentials": []
},
{
"Authorization_Code_PKCE": []
}
],
"summary": "Get artists relationship (\"to-many\").",
"tags": ["tracks"],
"x-path-item-properties": {
"required-access-tier": "THIRD_PARTY"
}
}
},
"/tracks/{id}/relationships/genres": {
"get": {
"operationId": "getTrackGenres",
"description": "Retrieves genres relationship.",
"parameters": [
{
"description": "Track id",
"example": "75413016",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "ISO 3166-1 alpha-2 country code",
"example": "US",
"in": "query",
"name": "countryCode",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: genres",
"example": "genres",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "genres"
}
}
},
{
"description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted.",
"in": "query",
"name": "shareCode",
"required": false,
"schema": {
"type": "string",
"example": "xyz"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Tracks_Multi_Relationship_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Client_Credentials": []
},
{
"Authorization_Code_PKCE": []
}
],
"summary": "Get genres relationship (\"to-many\").",
"tags": ["tracks"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
}
},
"/tracks/{id}/relationships/lyrics": {
"get": {
"operationId": "getTrackLyrics",
"description": "Retrieves lyrics relationship.",
"parameters": [
{
"description": "Track id",
"example": "75413016",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: lyrics",
"example": "lyrics",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "lyrics"
}
}
},
{
"description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted.",
"in": "query",
"name": "shareCode",
"required": false,
"schema": {
"type": "string",
"example": "xyz"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Tracks_Multi_Relationship_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Client_Credentials": []
},
{
"Authorization_Code_PKCE": []
}
],
"summary": "Get lyrics relationship (\"to-many\").",
"tags": ["tracks"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
}
},
"/tracks/{id}/relationships/owners": {
"get": {
"operationId": "getTrackOwners",
"description": "Retrieves owners relationship.",
"parameters": [
{
"description": "Track id",
"example": "75413016",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: owners",
"example": "owners",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "owners"
}
}
},
{
"description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted.",
"in": "query",
"name": "shareCode",
"required": false,
"schema": {
"type": "string",
"example": "xyz"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Tracks_Multi_Relationship_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Client_Credentials": []
},
{
"Authorization_Code_PKCE": []
}
],
"summary": "Get owners relationship (\"to-many\").",
"tags": ["tracks"],
"x-path-item-properties": {
"required-access-tier": "THIRD_PARTY"
}
}
},
"/tracks/{id}/relationships/providers": {
"get": {
"operationId": "getTrackProviders",
"description": "Retrieves providers relationship.",
"parameters": [
{
"description": "Track id",
"example": "75413016",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "ISO 3166-1 alpha-2 country code",
"example": "US",
"in": "query",
"name": "countryCode",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: providers",
"example": "providers",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "providers"
}
}
},
{
"description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted.",
"in": "query",
"name": "shareCode",
"required": false,
"schema": {
"type": "string",
"example": "xyz"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Tracks_Multi_Relationship_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Client_Credentials": []
},
{
"Authorization_Code_PKCE": []
}
],
"summary": "Get providers relationship (\"to-many\").",
"tags": ["tracks"],
"x-path-item-properties": {
"required-access-tier": "THIRD_PARTY"
}
}
},
"/tracks/{id}/relationships/radio": {
"get": {
"operationId": "getTrackRadio",
"description": "Retrieves radio relationship.",
"parameters": [
{
"description": "Track id",
"example": "75413016",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: radio",
"example": "radio",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "radio"
}
}
},
{
"description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted.",
"in": "query",
"name": "shareCode",
"required": false,
"schema": {
"type": "string",
"example": "xyz"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Tracks_Multi_Relationship_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Client_Credentials": []
},
{
"Authorization_Code_PKCE": []
}
],
"summary": "Get radio relationship (\"to-many\").",
"tags": ["tracks"],
"x-path-item-properties": {
"required-access-tier": "THIRD_PARTY"
}
}
},
"/tracks/{id}/relationships/replacement": {
"get": {
"operationId": "getTrackReplacementRelationship",
"description": "Retrieves replacement relationship.",
"parameters": [
{
"description": "Track id",
"example": "75413016",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "ISO 3166-1 alpha-2 country code",
"example": "US",
"in": "query",
"name": "countryCode",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: replacement",
"example": "replacement",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "replacement"
}
}
},
{
"description": "Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted.",
"in": "query",
"name": "shareCode",
"required": false,
"schema": {
"type": "string",
"example": "xyz"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Tracks_Single_Relationship_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Client_Credentials": []
},
{
"Authorization_Code_PKCE": []
}
],
"summary": "Get replacement relationship (\"to-one\").",
"tags": ["tracks"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
}
},
"/tracks/{id}/relationships/shares": {
"get": {
"operationId": "getTrackShares",
"description": "Retrieves shares relationship.",
"parameters": [
{
"description": "Track id",
"example": "75413016",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: shares",
"example": "shares",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "shares"
}
}
},
{
"description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted.",
"in": "query",
"name": "shareCode",
"required": false,
"schema": {
"type": "string",
"example": "xyz"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Tracks_Multi_Relationship_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["r_usr"]
}
],
"summary": "Get shares relationship (\"to-many\").",
"tags": ["tracks"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
}
},
"/tracks/{id}/relationships/similarTracks": {
"get": {
"operationId": "getTrackSimilarTracks",
"description": "Retrieves similarTracks relationship.",
"parameters": [
{
"description": "Track id",
"example": "75413016",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "ISO 3166-1 alpha-2 country code",
"example": "US",
"in": "query",
"name": "countryCode",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: similarTracks",
"example": "similarTracks",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "similarTracks"
}
}
},
{
"description": "Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted.",
"in": "query",
"name": "shareCode",
"required": false,
"schema": {
"type": "string",
"example": "xyz"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Tracks_Multi_Relationship_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Client_Credentials": []
},
{
"Authorization_Code_PKCE": []
}
],
"summary": "Get similarTracks relationship (\"to-many\").",
"tags": ["tracks"],
"x-path-item-properties": {
"required-access-tier": "THIRD_PARTY"
}
}
},
"/tracks/{id}/relationships/sourceFile": {
"get": {
"operationId": "getTrackTrackSourceFile",
"description": "Retrieves sourceFile relationship.",
"parameters": [
{
"description": "Track id",
"example": "75413016",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: sourceFile",
"example": "sourceFile",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "sourceFile"
}
}
},
{
"description": "Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted.",
"in": "query",
"name": "shareCode",
"required": false,
"schema": {
"type": "string",
"example": "xyz"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Tracks_Single_Relationship_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Client_Credentials": []
},
{
"Authorization_Code_PKCE": []
}
],
"summary": "Get sourceFile relationship (\"to-one\").",
"tags": ["tracks"],
"x-path-item-properties": {
"required-access-tier": "THIRD_PARTY"
}
}
},
"/tracks/{id}/relationships/trackStatistics": {
"get": {
"operationId": "getTrackTrackStatistics",
"description": "Retrieves trackStatistics relationship.",
"parameters": [
{
"description": "Track id",
"example": "75413016",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: trackStatistics",
"example": "trackStatistics",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "trackStatistics"
}
}
},
{
"description": "Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted.",
"in": "query",
"name": "shareCode",
"required": false,
"schema": {
"type": "string",
"example": "xyz"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Tracks_Single_Relationship_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": []
}
],
"summary": "Get trackStatistics relationship (\"to-one\").",
"tags": ["tracks"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
}
},
"/userCollectionFolders": {
"get": {
"operationId": "getUserCollectionFolders",
"description": "Retrieves multiple userCollectionFolders by available filters, or without if applicable.",
"parameters": [
{
"description": "Allows the client to customize which related resources should be returned. Available options: items, owners",
"example": "items",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "items"
}
}
},
{
"description": "Folder Id",
"example": "",
"in": "query",
"name": "filter[id]",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": ""
}
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserCollectionFolders_Multi_Resource_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["collection.read", "r_usr"]
}
],
"summary": "Get multiple userCollectionFolders.",
"tags": ["userCollectionFolders"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
},
"post": {
"operationId": "createUserCollectionFolder",
"description": "Creates a new userCollectionFolder.",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FolderCreateOperation_Payload"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserCollectionFolders_Single_Resource_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["collection.write", "w_usr"]
}
],
"summary": "Create single userCollectionFolder.",
"tags": ["userCollectionFolders"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
}
},
"/userCollectionFolders/{id}": {
"delete": {
"operationId": "deleteUserCollectionFolder",
"description": "Deletes existing userCollectionFolder.",
"parameters": [
{
"description": "Folder Id",
"example": "",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["collection.write", "w_usr"]
}
],
"summary": "Delete single userCollectionFolder.",
"tags": ["userCollectionFolders"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
},
"get": {
"operationId": "getUserCollectionFolder",
"description": "Retrieves single userCollectionFolder by id.",
"parameters": [
{
"description": "Folder Id",
"example": "",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: items, owners",
"example": "items",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "items"
}
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserCollectionFolders_Single_Resource_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["collection.read", "r_usr"]
}
],
"summary": "Get single userCollectionFolder.",
"tags": ["userCollectionFolders"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
},
"patch": {
"operationId": "patchUserCollectionFolder",
"description": "Updates existing userCollectionFolder.",
"parameters": [
{
"description": "Folder Id",
"example": "",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FolderUpdateOperation_Payload"
}
}
}
},
"responses": {
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["collection.write", "w_usr"]
}
],
"summary": "Update single userCollectionFolder.",
"tags": ["userCollectionFolders"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
}
},
"/userCollectionFolders/{id}/relationships/items": {
"delete": {
"operationId": "deleteUserCollectionFolderItems",
"description": "Deletes item(s) from items relationship.",
"parameters": [
{
"description": "Folder Id",
"example": "",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RemovePayload"
}
}
}
},
"responses": {
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["collection.write", "w_usr"]
}
],
"summary": "Delete from items relationship (\"to-many\").",
"tags": ["userCollectionFolders"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
},
"get": {
"operationId": "getUserCollectionFolderItems",
"description": "Retrieves items relationship.",
"parameters": [
{
"description": "Folder Id",
"example": "",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Values prefixed with \"-\" are sorted descending; values without it are sorted ascending.",
"in": "query",
"name": "sort",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "items.addedAt",
"enum": [
"items.addedAt",
"-items.addedAt",
"items.lastModifiedAt",
"-items.lastModifiedAt",
"items.name",
"-items.name"
],
"default": "items.addedAt",
"x-enum-varnames": [
"ItemsAddedAtAsc",
"ItemsAddedAtDesc",
"ItemsLastModifiedAtAsc",
"ItemsLastModifiedAtDesc",
"ItemsNameAsc",
"ItemsNameDesc"
]
}
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: items",
"example": "items",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "items"
}
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserCollectionFolders_Items_Multi_Relationship_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["collection.read", "r_usr"]
}
],
"summary": "Get items relationship (\"to-many\").",
"tags": ["userCollectionFolders"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
},
"post": {
"operationId": "addUserCollectionFolderItems",
"description": "Adds item(s) to items relationship.",
"parameters": [
{
"description": "Folder Id",
"example": "",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddPayload"
}
}
}
},
"responses": {
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["collection.write", "w_usr"]
}
],
"summary": "Add to items relationship (\"to-many\").",
"tags": ["userCollectionFolders"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
}
},
"/userCollectionFolders/{id}/relationships/owners": {
"get": {
"operationId": "getUserCollectionFolderOwners",
"description": "Retrieves owners relationship.",
"parameters": [
{
"description": "Folder Id",
"example": "",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: owners",
"example": "owners",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "owners"
}
}
},
{
"description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserCollectionFolders_Multi_Relationship_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["collection.read", "r_usr"]
}
],
"summary": "Get owners relationship (\"to-many\").",
"tags": ["userCollectionFolders"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
}
},
"/userCollections/{id}": {
"get": {
"operationId": "getUserCollection",
"description": "Retrieves single userCollection by id.",
"parameters": [
{
"description": "User collection id",
"example": "123456",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "ISO 3166-1 alpha-2 country code",
"example": "US",
"in": "query",
"name": "countryCode",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported.",
"example": "en-US",
"in": "query",
"name": "locale",
"required": false,
"schema": {
"type": "string",
"default": "en-US"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: albums, artists, owners, playlists, tracks, videos",
"example": "albums",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "albums"
}
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserCollections_Single_Resource_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["collection.read", "r_usr"]
}
],
"summary": "Get single userCollection.",
"tags": ["userCollections"],
"x-path-item-properties": {
"required-access-tier": "THIRD_PARTY"
}
}
},
"/userCollections/{id}/relationships/albums": {
"delete": {
"operationId": "deleteUserCollectionAlbums",
"description": "Deletes item(s) from albums relationship.",
"parameters": [
{
"description": "User collection id",
"example": "123456",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserCollectionAlbumsRelationshipRemoveOperation_Payload"
}
}
}
},
"responses": {
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["collection.write", "w_usr"]
}
],
"summary": "Delete from albums relationship (\"to-many\").",
"tags": ["userCollections"],
"x-path-item-properties": {
"required-access-tier": "THIRD_PARTY"
}
},
"get": {
"operationId": "getUserCollectionAlbums",
"description": "Retrieves albums relationship.",
"parameters": [
{
"description": "User collection id",
"example": "123456",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Values prefixed with \"-\" are sorted descending; values without it are sorted ascending.",
"in": "query",
"name": "sort",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "albums.addedAt",
"enum": [
"albums.addedAt",
"-albums.addedAt",
"albums.artists.name",
"-albums.artists.name",
"albums.releaseDate",
"-albums.releaseDate",
"albums.title",
"-albums.title"
],
"default": "-albums.addedAt",
"x-enum-varnames": [
"AlbumsAddedAtAsc",
"AlbumsAddedAtDesc",
"AlbumsArtistsNameAsc",
"AlbumsArtistsNameDesc",
"AlbumsReleaseDateAsc",
"AlbumsReleaseDateDesc",
"AlbumsTitleAsc",
"AlbumsTitleDesc"
]
}
}
},
{
"description": "ISO 3166-1 alpha-2 country code",
"example": "US",
"in": "query",
"name": "countryCode",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported.",
"example": "en-US",
"in": "query",
"name": "locale",
"required": false,
"schema": {
"type": "string",
"default": "en-US"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: albums",
"example": "albums",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "albums"
}
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserCollections_Albums_Multi_Relationship_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["collection.read", "r_usr"]
}
],
"summary": "Get albums relationship (\"to-many\").",
"tags": ["userCollections"],
"x-path-item-properties": {
"required-access-tier": "THIRD_PARTY"
}
},
"post": {
"operationId": "addUserCollectionAlbums",
"description": "Adds item(s) to albums relationship.",
"parameters": [
{
"description": "User collection id",
"example": "123456",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "ISO 3166-1 alpha-2 country code",
"example": "US",
"in": "query",
"name": "countryCode",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserCollectionAlbumsRelationshipAddOperation_Payload"
}
}
}
},
"responses": {
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["collection.write", "w_usr"]
}
],
"summary": "Add to albums relationship (\"to-many\").",
"tags": ["userCollections"],
"x-path-item-properties": {
"required-access-tier": "THIRD_PARTY"
}
}
},
"/userCollections/{id}/relationships/artists": {
"delete": {
"operationId": "deleteUserCollectionArtists",
"description": "Deletes item(s) from artists relationship.",
"parameters": [
{
"description": "User collection id",
"example": "123456",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserCollectionArtistsRelationshipRemoveOperation_Payload"
}
}
}
},
"responses": {
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["collection.write", "w_usr"]
}
],
"summary": "Delete from artists relationship (\"to-many\").",
"tags": ["userCollections"],
"x-path-item-properties": {
"required-access-tier": "THIRD_PARTY"
}
},
"get": {
"operationId": "getUserCollectionArtists",
"description": "Retrieves artists relationship.",
"parameters": [
{
"description": "User collection id",
"example": "123456",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Values prefixed with \"-\" are sorted descending; values without it are sorted ascending.",
"in": "query",
"name": "sort",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "artists.addedAt",
"enum": [
"artists.addedAt",
"-artists.addedAt",
"artists.name",
"-artists.name"
],
"default": "-artists.addedAt",
"x-enum-varnames": [
"ArtistsAddedAtAsc",
"ArtistsAddedAtDesc",
"ArtistsNameAsc",
"ArtistsNameDesc"
]
}
}
},
{
"description": "ISO 3166-1 alpha-2 country code",
"example": "US",
"in": "query",
"name": "countryCode",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported.",
"example": "en-US",
"in": "query",
"name": "locale",
"required": false,
"schema": {
"type": "string",
"default": "en-US"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: artists",
"example": "artists",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "artists"
}
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserCollections_Artists_Multi_Relationship_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["collection.read", "r_usr"]
}
],
"summary": "Get artists relationship (\"to-many\").",
"tags": ["userCollections"],
"x-path-item-properties": {
"required-access-tier": "THIRD_PARTY"
}
},
"post": {
"operationId": "addUserCollectionArtists",
"description": "Adds item(s) to artists relationship.",
"parameters": [
{
"description": "User collection id",
"example": "123456",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "ISO 3166-1 alpha-2 country code",
"example": "US",
"in": "query",
"name": "countryCode",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserCollectionArtistsRelationshipAddOperation_Payload"
}
}
}
},
"responses": {
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["collection.write", "w_usr"]
}
],
"summary": "Add to artists relationship (\"to-many\").",
"tags": ["userCollections"],
"x-path-item-properties": {
"required-access-tier": "THIRD_PARTY"
}
}
},
"/userCollections/{id}/relationships/owners": {
"get": {
"operationId": "getUserCollectionOwners",
"description": "Retrieves owners relationship.",
"parameters": [
{
"description": "User collection id",
"example": "123456",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: owners",
"example": "owners",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "owners"
}
}
},
{
"description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserCollections_Multi_Relationship_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["collection.read", "r_usr"]
}
],
"summary": "Get owners relationship (\"to-many\").",
"tags": ["userCollections"],
"x-path-item-properties": {
"required-access-tier": "THIRD_PARTY"
}
}
},
"/userCollections/{id}/relationships/playlists": {
"delete": {
"operationId": "deleteuserCollectionPlaylists",
"description": "Deletes item(s) from playlists relationship.",
"parameters": [
{
"description": "User collection id",
"example": "123456",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserCollectionPlaylistsRelationshipRemoveOperation_Payload"
}
}
}
},
"responses": {
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["collection.write", "w_usr"]
}
],
"summary": "Delete from playlists relationship (\"to-many\").",
"tags": ["userCollections"],
"x-path-item-properties": {
"required-access-tier": "THIRD_PARTY"
}
},
"get": {
"operationId": "getUserCollectionPlaylists",
"description": "Retrieves playlists relationship.",
"parameters": [
{
"description": "User collection id",
"example": "123456",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "collectionView",
"required": false,
"schema": {
"type": "string",
"enum": ["FOLDERS"]
}
},
{
"description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Values prefixed with \"-\" are sorted descending; values without it are sorted ascending.",
"in": "query",
"name": "sort",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "playlists.addedAt",
"enum": [
"playlists.addedAt",
"-playlists.addedAt",
"playlists.lastUpdatedAt",
"-playlists.lastUpdatedAt",
"playlists.name",
"-playlists.name"
],
"default": "-playlists.addedAt",
"x-enum-varnames": [
"PlaylistsAddedAtAsc",
"PlaylistsAddedAtDesc",
"PlaylistsLastUpdatedAtAsc",
"PlaylistsLastUpdatedAtDesc",
"PlaylistsNameAsc",
"PlaylistsNameDesc"
]
}
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: playlists",
"example": "playlists",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "playlists"
}
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserCollections_Playlists_Multi_Relationship_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["collection.read", "r_usr"]
}
],
"summary": "Get playlists relationship (\"to-many\").",
"tags": ["userCollections"],
"x-path-item-properties": {
"required-access-tier": "THIRD_PARTY"
}
},
"post": {
"operationId": "addUserCollectionPlaylists",
"description": "Adds item(s) to playlists relationship.",
"parameters": [
{
"description": "User collection id",
"example": "123456",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserCollectionPlaylistsRelationshipRemoveOperation_Payload"
}
}
}
},
"responses": {
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["collection.write", "w_usr"]
}
],
"summary": "Add to playlists relationship (\"to-many\").",
"tags": ["userCollections"],
"x-path-item-properties": {
"required-access-tier": "THIRD_PARTY"
}
}
},
"/userCollections/{id}/relationships/tracks": {
"delete": {
"operationId": "deleteUserCollectionTracks",
"description": "Deletes item(s) from tracks relationship.",
"parameters": [
{
"description": "User collection id",
"example": "123456",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserCollectionTracksRelationshipRemoveOperation_Payload"
}
}
}
},
"responses": {
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["collection.write", "w_usr"]
}
],
"summary": "Delete from tracks relationship (\"to-many\").",
"tags": ["userCollections"],
"x-path-item-properties": {
"required-access-tier": "THIRD_PARTY"
}
},
"get": {
"operationId": "getUserCollectionTracks",
"description": "Retrieves tracks relationship.",
"parameters": [
{
"description": "User collection id",
"example": "123456",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Values prefixed with \"-\" are sorted descending; values without it are sorted ascending.",
"in": "query",
"name": "sort",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "tracks.addedAt",
"enum": [
"tracks.addedAt",
"-tracks.addedAt",
"tracks.albums.title",
"-tracks.albums.title",
"tracks.artists.name",
"-tracks.artists.name",
"tracks.duration",
"-tracks.duration",
"tracks.title",
"-tracks.title"
],
"default": "-tracks.addedAt",
"x-enum-varnames": [
"TracksAddedAtAsc",
"TracksAddedAtDesc",
"TracksAlbumsTitleAsc",
"TracksAlbumsTitleDesc",
"TracksArtistsNameAsc",
"TracksArtistsNameDesc",
"TracksDurationAsc",
"TracksDurationDesc",
"TracksTitleAsc",
"TracksTitleDesc"
]
}
}
},
{
"description": "ISO 3166-1 alpha-2 country code",
"example": "US",
"in": "query",
"name": "countryCode",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported.",
"example": "en-US",
"in": "query",
"name": "locale",
"required": false,
"schema": {
"type": "string",
"default": "en-US"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: tracks",
"example": "tracks",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "tracks"
}
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserCollections_Tracks_Multi_Relationship_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["collection.read", "r_usr"]
}
],
"summary": "Get tracks relationship (\"to-many\").",
"tags": ["userCollections"],
"x-path-item-properties": {
"required-access-tier": "THIRD_PARTY"
}
},
"post": {
"operationId": "addUserCollectionTracks",
"description": "Adds item(s) to tracks relationship.",
"parameters": [
{
"description": "User collection id",
"example": "123456",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "ISO 3166-1 alpha-2 country code",
"example": "US",
"in": "query",
"name": "countryCode",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserCollectionTracksRelationshipAddOperation_Payload"
}
}
}
},
"responses": {
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["collection.write", "w_usr"]
}
],
"summary": "Add to tracks relationship (\"to-many\").",
"tags": ["userCollections"],
"x-path-item-properties": {
"required-access-tier": "THIRD_PARTY"
}
}
},
"/userCollections/{id}/relationships/videos": {
"delete": {
"operationId": "deleteUserCollectionVideos",
"description": "Deletes item(s) from videos relationship.",
"parameters": [
{
"description": "User collection id",
"example": "123456",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserCollectionVideosRelationshipRemoveOperation_Payload"
}
}
}
},
"responses": {
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["collection.write", "w_usr"]
}
],
"summary": "Delete from videos relationship (\"to-many\").",
"tags": ["userCollections"],
"x-path-item-properties": {
"required-access-tier": "THIRD_PARTY"
}
},
"get": {
"operationId": "getUserCollectionVideos",
"description": "Retrieves videos relationship.",
"parameters": [
{
"description": "User collection id",
"example": "123456",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Values prefixed with \"-\" are sorted descending; values without it are sorted ascending.",
"in": "query",
"name": "sort",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "videos.addedAt",
"enum": [
"videos.addedAt",
"-videos.addedAt",
"videos.artists.name",
"-videos.artists.name",
"videos.duration",
"-videos.duration",
"videos.title",
"-videos.title"
],
"default": "-videos.addedAt",
"x-enum-varnames": [
"VideosAddedAtAsc",
"VideosAddedAtDesc",
"VideosArtistsNameAsc",
"VideosArtistsNameDesc",
"VideosDurationAsc",
"VideosDurationDesc",
"VideosTitleAsc",
"VideosTitleDesc"
]
}
}
},
{
"description": "ISO 3166-1 alpha-2 country code",
"example": "US",
"in": "query",
"name": "countryCode",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported.",
"example": "en-US",
"in": "query",
"name": "locale",
"required": false,
"schema": {
"type": "string",
"default": "en-US"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: videos",
"example": "videos",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "videos"
}
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserCollections_Videos_Multi_Relationship_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["collection.read", "r_usr"]
}
],
"summary": "Get videos relationship (\"to-many\").",
"tags": ["userCollections"],
"x-path-item-properties": {
"required-access-tier": "THIRD_PARTY"
}
},
"post": {
"operationId": "addUserCollectionVideos",
"description": "Adds item(s) to videos relationship.",
"parameters": [
{
"description": "User collection id",
"example": "123456",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "ISO 3166-1 alpha-2 country code",
"example": "US",
"in": "query",
"name": "countryCode",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserCollectionVideosRelationshipAddOperation_Payload"
}
}
}
},
"responses": {
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["collection.write", "w_usr"]
}
],
"summary": "Add to videos relationship (\"to-many\").",
"tags": ["userCollections"],
"x-path-item-properties": {
"required-access-tier": "THIRD_PARTY"
}
}
},
"/userEntitlements/{id}": {
"get": {
"operationId": "getUserEntitlement",
"description": "Retrieves single userEntitlement by id.",
"parameters": [
{
"description": "User id",
"example": "123456",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: owners",
"example": "owners",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "owners"
}
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserEntitlements_Single_Resource_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["entitlements.read", "r_usr"]
}
],
"summary": "Get single userEntitlement.",
"tags": ["userEntitlements"],
"x-path-item-properties": {
"required-access-tier": "THIRD_PARTY"
}
}
},
"/userEntitlements/{id}/relationships/owners": {
"get": {
"operationId": "getUserEntitlementOwners",
"description": "Retrieves owners relationship.",
"parameters": [
{
"description": "User id",
"example": "123456",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: owners",
"example": "owners",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "owners"
}
}
},
{
"description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserEntitlements_Multi_Relationship_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["entitlements.read", "r_usr"]
}
],
"summary": "Get owners relationship (\"to-many\").",
"tags": ["userEntitlements"],
"x-path-item-properties": {
"required-access-tier": "THIRD_PARTY"
}
}
},
"/userRecommendations/{id}": {
"get": {
"operationId": "getUserRecommendation",
"description": "Retrieves single userRecommendation by id.",
"parameters": [
{
"description": "User recommendations id",
"example": "123456",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "ISO 3166-1 alpha-2 country code",
"example": "US",
"in": "query",
"name": "countryCode",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported.",
"example": "en-US",
"in": "query",
"name": "locale",
"required": false,
"schema": {
"type": "string",
"default": "en-US"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: discoveryMixes, myMixes, newArrivalMixes",
"example": "discoveryMixes",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "discoveryMixes"
}
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserRecommendations_Single_Resource_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["r_usr", "recommendations.read"]
}
],
"summary": "Get single userRecommendation.",
"tags": ["userRecommendations"],
"x-path-item-properties": {
"required-access-tier": "THIRD_PARTY"
}
}
},
"/userRecommendations/{id}/relationships/discoveryMixes": {
"get": {
"operationId": "getUserRecommendationDiscoveryMixes",
"description": "Retrieves discoveryMixes relationship.",
"parameters": [
{
"description": "User recommendations id",
"example": "123456",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "ISO 3166-1 alpha-2 country code",
"example": "US",
"in": "query",
"name": "countryCode",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported.",
"example": "en-US",
"in": "query",
"name": "locale",
"required": false,
"schema": {
"type": "string",
"default": "en-US"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: discoveryMixes",
"example": "discoveryMixes",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "discoveryMixes"
}
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserRecommendations_Multi_Relationship_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["r_usr", "recommendations.read"]
}
],
"summary": "Get discoveryMixes relationship (\"to-many\").",
"tags": ["userRecommendations"],
"x-path-item-properties": {
"required-access-tier": "THIRD_PARTY"
}
}
},
"/userRecommendations/{id}/relationships/myMixes": {
"get": {
"operationId": "getUserRecommendationMyMixes",
"description": "Retrieves myMixes relationship.",
"parameters": [
{
"description": "User recommendations id",
"example": "123456",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "ISO 3166-1 alpha-2 country code",
"example": "US",
"in": "query",
"name": "countryCode",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported.",
"example": "en-US",
"in": "query",
"name": "locale",
"required": false,
"schema": {
"type": "string",
"default": "en-US"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: myMixes",
"example": "myMixes",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "myMixes"
}
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserRecommendations_Multi_Relationship_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["r_usr", "recommendations.read"]
}
],
"summary": "Get myMixes relationship (\"to-many\").",
"tags": ["userRecommendations"],
"x-path-item-properties": {
"required-access-tier": "THIRD_PARTY"
}
}
},
"/userRecommendations/{id}/relationships/newArrivalMixes": {
"get": {
"operationId": "getUserRecommendationNewArrivalMixes",
"description": "Retrieves newArrivalMixes relationship.",
"parameters": [
{
"description": "User recommendations id",
"example": "123456",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "ISO 3166-1 alpha-2 country code",
"example": "US",
"in": "query",
"name": "countryCode",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported.",
"example": "en-US",
"in": "query",
"name": "locale",
"required": false,
"schema": {
"type": "string",
"default": "en-US"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: newArrivalMixes",
"example": "newArrivalMixes",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "newArrivalMixes"
}
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserRecommendations_Multi_Relationship_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["r_usr", "recommendations.read"]
}
],
"summary": "Get newArrivalMixes relationship (\"to-many\").",
"tags": ["userRecommendations"],
"x-path-item-properties": {
"required-access-tier": "THIRD_PARTY"
}
}
},
"/userReports": {
"post": {
"operationId": "createUserReport",
"description": "Creates a new userReport.",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserReportCreateOperation_Payload"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserReports_Single_Resource_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["w_usr"]
}
],
"summary": "Create single userReport.",
"tags": ["userReports"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
}
},
"/users/me": {
"get": {
"operationId": "getMe",
"description": "Retrieves current user's user.",
"parameters": [],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Users_Single_Resource_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Authorization_Code_PKCE": ["r_usr", "user.read"]
}
],
"summary": "Get current user's user.",
"tags": ["users"],
"x-path-item-properties": {
"required-access-tier": "THIRD_PARTY"
}
}
},
"/videos": {
"get": {
"operationId": "getVideos",
"description": "Retrieves multiple videos by available filters, or without if applicable.",
"parameters": [
{
"description": "ISO 3166-1 alpha-2 country code",
"example": "US",
"in": "query",
"name": "countryCode",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: albums, artists, providers, replacement, thumbnailArt",
"example": "albums",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "albums"
}
}
},
{
"description": "Video id",
"example": "75623239",
"in": "query",
"name": "filter[id]",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "75623239"
}
}
},
{
"description": "International Standard Recording Code (ISRC)",
"example": "QMJMT1701237",
"in": "query",
"name": "filter[isrc]",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "QMJMT1701237"
}
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Videos_Multi_Resource_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Client_Credentials": []
},
{
"Authorization_Code_PKCE": []
}
],
"summary": "Get multiple videos.",
"tags": ["videos"],
"x-path-item-properties": {
"required-access-tier": "THIRD_PARTY"
}
}
},
"/videos/{id}": {
"get": {
"operationId": "getVideo",
"description": "Retrieves single video by id.",
"parameters": [
{
"description": "Video id",
"example": "75623239",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "ISO 3166-1 alpha-2 country code",
"example": "US",
"in": "query",
"name": "countryCode",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: albums, artists, providers, replacement, thumbnailArt",
"example": "albums",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "albums"
}
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Videos_Single_Resource_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Client_Credentials": []
},
{
"Authorization_Code_PKCE": []
}
],
"summary": "Get single video.",
"tags": ["videos"],
"x-path-item-properties": {
"required-access-tier": "THIRD_PARTY"
}
}
},
"/videos/{id}/relationships/albums": {
"get": {
"operationId": "getVideoAlbums",
"description": "Retrieves albums relationship.",
"parameters": [
{
"description": "Video id",
"example": "75623239",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "ISO 3166-1 alpha-2 country code",
"example": "US",
"in": "query",
"name": "countryCode",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: albums",
"example": "albums",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "albums"
}
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Videos_Multi_Relationship_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Client_Credentials": []
},
{
"Authorization_Code_PKCE": []
}
],
"summary": "Get albums relationship (\"to-many\").",
"tags": ["videos"],
"x-path-item-properties": {
"required-access-tier": "THIRD_PARTY"
}
}
},
"/videos/{id}/relationships/artists": {
"get": {
"operationId": "getVideoArtists",
"description": "Retrieves artists relationship.",
"parameters": [
{
"description": "Video id",
"example": "75623239",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "ISO 3166-1 alpha-2 country code",
"example": "US",
"in": "query",
"name": "countryCode",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: artists",
"example": "artists",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "artists"
}
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Videos_Multi_Relationship_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Client_Credentials": []
},
{
"Authorization_Code_PKCE": []
}
],
"summary": "Get artists relationship (\"to-many\").",
"tags": ["videos"],
"x-path-item-properties": {
"required-access-tier": "THIRD_PARTY"
}
}
},
"/videos/{id}/relationships/providers": {
"get": {
"operationId": "getVideoProviders",
"description": "Retrieves providers relationship.",
"parameters": [
{
"description": "Video id",
"example": "75623239",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "ISO 3166-1 alpha-2 country code",
"example": "US",
"in": "query",
"name": "countryCode",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: providers",
"example": "providers",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "providers"
}
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Videos_Multi_Relationship_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Client_Credentials": []
},
{
"Authorization_Code_PKCE": []
}
],
"summary": "Get providers relationship (\"to-many\").",
"tags": ["videos"],
"x-path-item-properties": {
"required-access-tier": "THIRD_PARTY"
}
}
},
"/videos/{id}/relationships/replacement": {
"get": {
"operationId": "getVideoReplacementRelationship",
"description": "Retrieves replacement relationship.",
"parameters": [
{
"description": "Video id",
"example": "75623239",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "ISO 3166-1 alpha-2 country code",
"example": "US",
"in": "query",
"name": "countryCode",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: replacement",
"example": "replacement",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "replacement"
}
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Videos_Single_Relationship_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Client_Credentials": []
},
{
"Authorization_Code_PKCE": []
}
],
"summary": "Get replacement relationship (\"to-one\").",
"tags": ["videos"],
"x-path-item-properties": {
"required-access-tier": "INTERNAL"
}
}
},
"/videos/{id}/relationships/thumbnailArt": {
"get": {
"operationId": "getVideoThumbnailArt",
"description": "Retrieves thumbnailArt relationship.",
"parameters": [
{
"description": "Video id",
"example": "75623239",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "ISO 3166-1 alpha-2 country code",
"example": "US",
"in": "query",
"name": "countryCode",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Allows the client to customize which related resources should be returned. Available options: thumbnailArt",
"example": "thumbnailArt",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "thumbnailArt"
}
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Videos_Multi_Relationship_Data_Document"
}
}
},
"description": "Successful response"
},
"400": {
"$ref": "#/components/responses/Default400Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"406": {
"$ref": "#/components/responses/Default406Response"
},
"415": {
"$ref": "#/components/responses/Default415Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
},
"503": {
"$ref": "#/components/responses/Default503Response"
}
},
"security": [
{
"Client_Credentials": []
},
{
"Authorization_Code_PKCE": []
}
],
"summary": "Get thumbnailArt relationship (\"to-many\").",
"tags": ["videos"],
"x-path-item-properties": {
"required-access-tier": "THIRD_PARTY"
}
}
}
},
"components": {
"responses": {
"Default400Response": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Default400ResponseBody"
}
}
},
"description": "The request is malformed or invalid"
},
"Default404Response": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Default404ResponseBody"
}
}
},
"description": "The requested resource was not found"
},
"Default405Response": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Default405ResponseBody"
}
}
},
"description": "The HTTP method is not allowed for the requested resource"
},
"Default406Response": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Default406ResponseBody"
}
}
},
"description": "A response that satisfies the content negotiation headers cannot be produced"
},
"Default415Response": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Default415ResponseBody"
}
}
},
"description": "Unsupported request payload media type or content encoding"
},
"Default429Response": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Default429ResponseBody"
}
}
},
"description": "Rate limit exceeded"
},
"Default500Response": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Default500ResponseBody"
}
}
},
"description": "An unexpected error was encountered"
},
"Default503Response": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Default503ResponseBody"
}
}
},
"description": "Temporarily unavailable; please try again later"
},
"TrackFilesReadById403Response": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TrackFilesReadById403ResponseBody"
}
}
},
"description": "Cannot fulfill this request because required prerequisites are missing; The requested content is not available in your location; The requested content must be purchased to be accessed; Client is not allowed to access this content; This account is playing on another app or device"
},
"TrackFilesReadById404Response": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TrackFilesReadById404ResponseBody"
}
}
},
"description": "The requested content does not exist or is no longer available"
},
"TrackManifestsReadById403Response": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TrackManifestsReadById403ResponseBody"
}
}
},
"description": "Cannot fulfill this request because required prerequisites are missing; The requested content is not available in your location; The requested content must be purchased to be accessed; Client is not allowed to access this content; This account is playing on another app or device"
},
"TrackManifestsReadById404Response": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TrackManifestsReadById404ResponseBody"
}
}
},
"description": "The requested content does not exist or is no longer available"
}
},
"schemas": {
"AddPayload": {
"type": "object",
"properties": {
"data": {
"maxItems": 10,
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/Data"
}
}
}
},
"AlbumCoverArtRelationshipUpdateOperation_Payload": {
"required": ["data"],
"type": "object",
"properties": {
"data": {
"maxItems": 1,
"minItems": 0,
"type": "array",
"items": {
"$ref": "#/components/schemas/AlbumCoverArtRelationshipUpdateOperation_Payload_Data"
}
}
}
},
"AlbumCoverArtRelationshipUpdateOperation_Payload_Data": {
"required": ["id", "type"],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["artworks"]
}
}
},
"AlbumCreateOperation_Payload": {
"required": ["data"],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/AlbumCreateOperation_Payload_Data"
}
}
},
"AlbumCreateOperation_Payload_Data": {
"required": ["attributes", "relationships", "type"],
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/AlbumCreateOperation_Payload_Data_Attributes"
},
"relationships": {
"$ref": "#/components/schemas/AlbumCreateOperation_Payload_Data_Relationships"
},
"type": {
"type": "string",
"enum": ["albums"]
}
}
},
"AlbumCreateOperation_Payload_Data_Attributes": {
"required": ["title"],
"type": "object",
"properties": {
"albumType": {
"type": "string",
"enum": ["ALBUM", "EP", "SINGLE"]
},
"copyright": {
"$ref": "#/components/schemas/Copyright"
},
"explicitLyrics": {
"type": "boolean"
},
"releaseDate": {
"type": "string",
"format": "date"
},
"title": {
"type": "string"
},
"upc": {
"maxLength": 13,
"minLength": 12,
"type": "string"
},
"version": {
"type": "string"
}
}
},
"AlbumCreateOperation_Payload_Data_Relationships": {
"required": ["artists"],
"type": "object",
"properties": {
"artists": {
"$ref": "#/components/schemas/AlbumCreateOperation_Payload_Data_Relationships_Artists"
},
"genres": {
"$ref": "#/components/schemas/AlbumCreateOperation_Payload_Data_Relationships_Genres"
}
}
},
"AlbumCreateOperation_Payload_Data_Relationships_Artists": {
"required": ["data"],
"type": "object",
"properties": {
"data": {
"maxItems": 1,
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/AlbumCreateOperation_Payload_Data_Relationships_Artists_Data"
}
}
}
},
"AlbumCreateOperation_Payload_Data_Relationships_Artists_Data": {
"required": ["id", "type"],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["artists"]
}
}
},
"AlbumCreateOperation_Payload_Data_Relationships_Genres": {
"required": ["data"],
"type": "object",
"properties": {
"data": {
"maxItems": 3,
"minItems": 0,
"type": "array",
"items": {
"$ref": "#/components/schemas/AlbumCreateOperation_Payload_Data_Relationships_Genres_Data"
}
}
}
},
"AlbumCreateOperation_Payload_Data_Relationships_Genres_Data": {
"required": ["id", "type"],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["genres"]
}
}
},
"AlbumItemsRelationshipUpdateOperation_Payload": {
"required": ["data", "meta"],
"type": "object",
"properties": {
"data": {
"maxItems": 1,
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/AlbumItemsRelationshipUpdateOperation_Payload_Data"
}
},
"meta": {
"$ref": "#/components/schemas/AlbumItemsRelationshipUpdateOperation_Payload_Meta"
}
}
},
"AlbumItemsRelationshipUpdateOperation_Payload_Data": {
"required": ["id", "type"],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["tracks", "videos"]
}
}
},
"AlbumItemsRelationshipUpdateOperation_Payload_Meta": {
"required": ["positionIndex"],
"type": "object",
"properties": {
"positionIndex": {
"type": "integer",
"description": "1-based index",
"format": "int32"
}
}
},
"AlbumUpdateOperation_Payload": {
"required": ["data"],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/AlbumUpdateOperation_Payload_Data"
}
}
},
"AlbumUpdateOperation_Payload_Data": {
"required": ["id", "type"],
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/AlbumUpdateOperation_Payload_Data_Attributes"
},
"id": {
"type": "string"
},
"relationships": {
"$ref": "#/components/schemas/AlbumUpdateOperation_Payload_Data_Relationships"
},
"type": {
"type": "string",
"enum": ["albums"]
}
}
},
"AlbumUpdateOperation_Payload_Data_Attributes": {
"type": "object",
"properties": {
"accessType": {
"type": "string",
"description": "Access type",
"example": "PRIVATE",
"enum": ["PUBLIC", "UNLISTED", "PRIVATE"]
},
"albumType": {
"type": "string",
"enum": ["ALBUM", "EP", "SINGLE"]
},
"copyright": {
"$ref": "#/components/schemas/Copyright"
},
"explicitLyrics": {
"type": "boolean"
},
"releaseDate": {
"type": "string",
"format": "date"
},
"title": {
"type": "string"
},
"version": {
"type": "string"
}
}
},
"AlbumUpdateOperation_Payload_Data_Relationships": {
"type": "object",
"properties": {
"genres": {
"$ref": "#/components/schemas/AlbumUpdateOperation_Payload_Data_Relationships_Genres"
}
}
},
"AlbumUpdateOperation_Payload_Data_Relationships_Genres": {
"required": ["data"],
"type": "object",
"properties": {
"data": {
"maxItems": 3,
"minItems": 0,
"type": "array",
"items": {
"$ref": "#/components/schemas/AlbumUpdateOperation_Payload_Data_Relationships_Genres_Data"
}
}
}
},
"AlbumUpdateOperation_Payload_Data_Relationships_Genres_Data": {
"required": ["id", "type"],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["genres"]
}
}
},
"Albums_Attributes": {
"required": [
"barcodeId",
"duration",
"explicit",
"mediaTags",
"numberOfItems",
"numberOfVolumes",
"popularity",
"title",
"type"
],
"type": "object",
"properties": {
"accessType": {
"type": "string",
"description": "Access type",
"example": "PRIVATE",
"enum": ["PUBLIC", "UNLISTED", "PRIVATE"]
},
"availability": {
"type": "array",
"description": "Available usage for this album",
"items": {
"type": "string",
"enum": ["STREAM", "DJ", "STEM"]
}
},
"barcodeId": {
"type": "string",
"description": "Barcode id (EAN-13 or UPC-A)",
"example": "00854242007552"
},
"copyright": {
"$ref": "#/components/schemas/Copyright"
},
"duration": {
"type": "string",
"description": "Duration (ISO 8601)",
"example": "PT46M17S"
},
"explicit": {
"type": "boolean",
"description": "Explicit content",
"example": true
},
"externalLinks": {
"type": "array",
"description": "Album links external to TIDAL API",
"items": {
"$ref": "#/components/schemas/External_Link"
}
},
"mediaTags": {
"type": "array",
"items": {
"type": "string",
"description": "Media metadata tags",
"example": "HIRES_LOSSLESS, LOSSLESS"
}
},
"numberOfItems": {
"type": "integer",
"description": "Number of items in album",
"format": "int32",
"example": 13
},
"numberOfVolumes": {
"type": "integer",
"description": "Number of volumes",
"format": "int32",
"example": 1
},
"popularity": {
"type": "number",
"description": "Popularity (0.0 - 1.0)",
"format": "double",
"example": 0.56
},
"releaseDate": {
"type": "string",
"description": "Release date (ISO-8601)",
"format": "date",
"example": "2017-06-30"
},
"title": {
"type": "string",
"description": "Album title",
"example": "4:44"
},
"type": {
"type": "string",
"description": "Album type",
"enum": ["ALBUM", "EP", "SINGLE"]
},
"version": {
"type": "string",
"description": "Album version",
"example": "remix"
}
}
},
"Albums_Items_Multi_Relationship_Data_Document": {
"required": ["links"],
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Albums_Items_Resource_Identifier"
}
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"Albums_Items_Resource_Identifier": {
"required": ["id", "type"],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Resource id",
"example": "12345"
},
"meta": {
"$ref": "#/components/schemas/Albums_Items_Resource_Identifier_Meta"
},
"type": {
"type": "string",
"description": "Resource type",
"example": "tracks"
}
}
},
"Albums_Items_Resource_Identifier_Meta": {
"required": ["trackNumber", "volumeNumber"],
"type": "object",
"properties": {
"trackNumber": {
"type": "integer",
"description": "track number",
"format": "int32",
"example": 4
},
"volumeNumber": {
"type": "integer",
"description": "volume number",
"format": "int32",
"example": 1
}
}
},
"Albums_Multi_Relationship_Data_Document": {
"required": ["links"],
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Resource_Identifier"
}
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"Albums_Multi_Resource_Data_Document": {
"required": ["data", "links"],
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Albums_Resource_Object"
}
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"Albums_Relationships": {
"required": [
"artists",
"coverArt",
"genres",
"items",
"owners",
"providers",
"replacement",
"similarAlbums",
"suggestedCoverArts"
],
"properties": {
"artists": {
"$ref": "#/components/schemas/Multi_Relationship_Data_Document"
},
"coverArt": {
"$ref": "#/components/schemas/Multi_Relationship_Data_Document"
},
"genres": {
"$ref": "#/components/schemas/Multi_Relationship_Data_Document"
},
"items": {
"$ref": "#/components/schemas/Albums_Items_Multi_Relationship_Data_Document"
},
"owners": {
"$ref": "#/components/schemas/Multi_Relationship_Data_Document"
},
"providers": {
"$ref": "#/components/schemas/Multi_Relationship_Data_Document"
},
"replacement": {
"$ref": "#/components/schemas/Single_Relationship_Data_Document"
},
"similarAlbums": {
"$ref": "#/components/schemas/Multi_Relationship_Data_Document"
},
"suggestedCoverArts": {
"$ref": "#/components/schemas/Albums_SuggestedCoverArts_Multi_Relationship_Data_Document"
}
}
},
"Albums_Resource_Object": {
"required": ["id", "type"],
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/Albums_Attributes"
},
"id": {
"type": "string",
"description": "Resource id",
"example": "12345"
},
"relationships": {
"$ref": "#/components/schemas/Albums_Relationships"
},
"type": {
"minLength": 1,
"type": "string",
"description": "Resource type",
"example": "tracks"
}
}
},
"Albums_Single_Relationship_Data_Document": {
"required": ["links"],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Resource_Identifier"
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"Albums_Single_Resource_Data_Document": {
"required": ["data", "links"],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Albums_Resource_Object"
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"Albums_SuggestedCoverArts_Multi_Relationship_Data_Document": {
"required": ["links"],
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Albums_SuggestedCoverArts_Resource_Identifier"
}
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"Albums_SuggestedCoverArts_Resource_Identifier": {
"required": ["id", "type"],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Resource id",
"example": "12345"
},
"meta": {
"$ref": "#/components/schemas/Albums_SuggestedCoverArts_Resource_Identifier_Meta"
},
"type": {
"type": "string",
"description": "Resource type",
"example": "tracks"
}
}
},
"Albums_SuggestedCoverArts_Resource_Identifier_Meta": {
"required": ["backgroundColor", "foregroundColor"],
"type": "object",
"properties": {
"backgroundColor": {
"type": "string",
"description": "Background color for the suggested artwork"
},
"foregroundColor": {
"type": "string",
"description": "Foreground color for the suggested artwork"
}
}
},
"AppreciationsCreateOperation_Meta": {
"type": "object",
"properties": {
"dryRun": {
"type": "boolean"
}
}
},
"AppreciationsCreateOperation_Payload": {
"required": ["data"],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/AppreciationsCreateOperation_Payload_Data"
},
"meta": {
"$ref": "#/components/schemas/AppreciationsCreateOperation_Meta"
}
}
},
"AppreciationsCreateOperation_Payload_Data": {
"required": ["relationships", "type"],
"type": "object",
"properties": {
"relationships": {
"$ref": "#/components/schemas/AppreciationsCreateOperation_Payload_Data_Relationships"
},
"type": {
"type": "string",
"enum": ["appreciations"]
}
}
},
"AppreciationsCreateOperation_Payload_Data_Relationships": {
"required": ["appreciatedItems"],
"type": "object",
"properties": {
"appreciatedItems": {
"$ref": "#/components/schemas/AppreciationsCreateOperation_Payload_Data_Relationships_AppreciatedItem"
}
}
},
"AppreciationsCreateOperation_Payload_Data_Relationships_AppreciatedItem": {
"required": ["data"],
"type": "object",
"properties": {
"data": {
"maxItems": 1,
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/AppreciationsCreateOperation_Payload_Data_Relationships_AppreciatedItem_Data"
}
}
}
},
"AppreciationsCreateOperation_Payload_Data_Relationships_AppreciatedItem_Data": {
"required": ["id", "type"],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["artists"]
}
}
},
"Appreciations_Attributes": {
"required": ["createdAt"],
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"description": "Time when the appreciation was created",
"format": "date-time",
"example": "2025-09-09T13:07:35.734Z"
}
}
},
"Appreciations_Multi_Resource_Data_Document": {
"required": ["data", "links"],
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Appreciations_Resource_Object"
}
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"Appreciations_Resource_Object": {
"required": ["id", "type"],
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/Appreciations_Attributes"
},
"id": {
"type": "string",
"description": "Resource id",
"example": "12345"
},
"type": {
"minLength": 1,
"type": "string",
"description": "Resource type",
"example": "tracks"
}
}
},
"Appreciations_Single_Resource_Data_Document": {
"required": ["data", "links"],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Appreciations_Resource_Object"
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"ArtistBiographies_Attributes": {
"required": ["editable", "text"],
"type": "object",
"properties": {
"editable": {
"type": "boolean",
"description": "Boolean to indicate if the biography is editable (source = tidal or artist)",
"example": true
},
"text": {
"type": "string",
"description": "Artist biography",
"example": "Once upon a time an artist is born"
}
}
},
"ArtistBiographies_Multi_Relationship_Data_Document": {
"required": ["links"],
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Resource_Identifier"
}
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"ArtistBiographies_Multi_Resource_Data_Document": {
"required": ["data", "links"],
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ArtistBiographies_Resource_Object"
}
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"ArtistBiographies_Relationships": {
"required": ["owners"],
"properties": {
"owners": {
"$ref": "#/components/schemas/Multi_Relationship_Data_Document"
}
}
},
"ArtistBiographies_Resource_Object": {
"required": ["id", "type"],
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/ArtistBiographies_Attributes"
},
"id": {
"type": "string",
"description": "Resource id",
"example": "12345"
},
"relationships": {
"$ref": "#/components/schemas/ArtistBiographies_Relationships"
},
"type": {
"minLength": 1,
"type": "string",
"description": "Resource type",
"example": "tracks"
}
}
},
"ArtistBiographies_Single_Resource_Data_Document": {
"required": ["data", "links"],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ArtistBiographies_Resource_Object"
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"ArtistBiographyUpdateBody": {
"required": ["data"],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ArtistBiographyUpdateBody_Data"
}
}
},
"ArtistBiographyUpdateBody_Data": {
"required": ["attributes", "id", "type"],
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/ArtistBiographyUpdateBody_Data_Attributes"
},
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["artistBiographies"]
}
}
},
"ArtistBiographyUpdateBody_Data_Attributes": {
"type": "object",
"properties": {
"text": {
"type": "string"
}
}
},
"ArtistClaimAcceptedArtistsRelationshipUpdateOperation_Payload": {
"required": ["data"],
"type": "object",
"properties": {
"data": {
"maxItems": 1,
"minItems": 0,
"type": "array",
"items": {
"$ref": "#/components/schemas/ArtistClaimAcceptedArtistsRelationshipUpdateOperation_Payload_Data"
}
}
}
},
"ArtistClaimAcceptedArtistsRelationshipUpdateOperation_Payload_Data": {
"required": ["id", "type"],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["artists"]
}
}
},
"ArtistClaimsCreateOperation_Payload": {
"required": ["data", "meta"],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ArtistClaimsCreateOperation_Payload_Data"
},
"meta": {
"$ref": "#/components/schemas/ArtistClaimsCreateOperation_Payload_Meta"
}
}
},
"ArtistClaimsCreateOperation_Payload_Data": {
"required": ["attributes", "type"],
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/ArtistClaimsCreateOperation_Payload_Data_Attributes"
},
"type": {
"type": "string",
"enum": ["artistClaims"]
}
}
},
"ArtistClaimsCreateOperation_Payload_Data_Attributes": {
"required": ["artistId", "provider"],
"type": "object",
"properties": {
"artistId": {
"type": "string"
},
"provider": {
"type": "string",
"enum": ["DISTROKID", "CDBABY", "TUNECORE"]
}
}
},
"ArtistClaimsCreateOperation_Payload_Meta": {
"required": ["redirectUrl"],
"type": "object",
"properties": {
"nonce": {
"type": "string"
},
"redirectUrl": {
"type": "string"
}
}
},
"ArtistClaimsUpdateOperation_Payload": {
"required": ["meta"],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ArtistClaimsUpdateOperation_Payload_Data"
},
"meta": {
"$ref": "#/components/schemas/ArtistClaimsUpdateOperation_Payload_Meta"
}
}
},
"ArtistClaimsUpdateOperation_Payload_Data": {
"required": ["type"],
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/ArtistClaimsUpdateOperation_Payload_Data_Attributes"
},
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["artistClaims"]
}
}
},
"ArtistClaimsUpdateOperation_Payload_Data_Attributes": {
"type": "object"
},
"ArtistClaimsUpdateOperation_Payload_Meta": {
"required": ["authorizationCode", "redirectUri"],
"type": "object",
"properties": {
"authorizationCode": {
"type": "string"
},
"redirectUri": {
"type": "string"
}
}
},
"ArtistClaims_Attributes": {
"required": ["artistId", "provider", "status"],
"type": "object",
"properties": {
"artistId": {
"type": "string",
"description": "The artist id which is being claimed"
},
"externalLinks": {
"type": "array",
"description": "Artist claim links external to TIDAL API",
"items": {
"$ref": "#/components/schemas/External_Link"
}
},
"provider": {
"minLength": 1,
"type": "string",
"description": "The DSP used for authentication",
"enum": ["DISTROKID", "CDBABY", "TUNECORE"]
},
"recommendation": {
"type": "string",
"description": "The recommended claim resolution",
"enum": ["CLAIM_PROFILE", "CLAIM_CONTENT"]
},
"retrievedUpcs": {
"type": "array",
"description": "List of UPCs retrieved from the DSP",
"items": {
"$ref": "#/components/schemas/BarcodeId"
}
},
"status": {
"minLength": 1,
"type": "string",
"description": "Current status of this claim",
"enum": [
"AWAITING_OAUTH",
"FETCHING_CONTENT",
"VERIFIED",
"NO_MATCHES",
"AUTHENTICATION_FAILED",
"PROCESSING",
"COMPLETED",
"FAILED",
"CANCELLED"
]
}
}
},
"ArtistClaims_Multi_Relationship_Data_Document": {
"required": ["links"],
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Resource_Identifier"
}
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"ArtistClaims_Multi_Resource_Data_Document": {
"required": ["data", "links"],
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ArtistClaims_Resource_Object"
}
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"ArtistClaims_Relationships": {
"required": ["acceptedArtists", "owners", "recommendedArtists"],
"properties": {
"acceptedArtists": {
"$ref": "#/components/schemas/Multi_Relationship_Data_Document"
},
"owners": {
"$ref": "#/components/schemas/Multi_Relationship_Data_Document"
},
"recommendedArtists": {
"$ref": "#/components/schemas/Multi_Relationship_Data_Document"
}
}
},
"ArtistClaims_Resource_Object": {
"required": ["id", "type"],
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/ArtistClaims_Attributes"
},
"id": {
"type": "string",
"description": "Resource id",
"example": "12345"
},
"relationships": {
"$ref": "#/components/schemas/ArtistClaims_Relationships"
},
"type": {
"minLength": 1,
"type": "string",
"description": "Resource type",
"example": "tracks"
}
}
},
"ArtistClaims_Single_Resource_Data_Document": {
"required": ["data", "links"],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ArtistClaims_Resource_Object"
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"ArtistCreateOperation_Meta": {
"type": "object",
"properties": {
"dryRun": {
"type": "boolean"
}
}
},
"ArtistCreateOperation_Payload": {
"required": ["data"],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ArtistCreateOperation_Payload_Data"
},
"meta": {
"$ref": "#/components/schemas/ArtistCreateOperation_Meta"
}
}
},
"ArtistCreateOperation_Payload_Data": {
"required": ["attributes", "type"],
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/ArtistCreateOperation_Payload_Data_Attributes"
},
"type": {
"type": "string",
"enum": ["artists"]
}
}
},
"ArtistCreateOperation_Payload_Data_Attributes": {
"required": ["name"],
"type": "object",
"properties": {
"handle": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"ArtistFollowingRelationshipAddOperation_Payload": {
"required": ["data"],
"type": "object",
"properties": {
"data": {
"maxItems": 1,
"minItems": 0,
"type": "array",
"items": {
"$ref": "#/components/schemas/ArtistFollowingRelationshipAddOperation_Payload_Data"
}
}
}
},
"ArtistFollowingRelationshipAddOperation_Payload_Data": {
"required": ["id", "type"],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["artists"]
}
}
},
"ArtistFollowingRelationshipRemoveOperation_Payload": {
"required": ["data"],
"type": "object",
"properties": {
"data": {
"maxItems": 1,
"minItems": 0,
"type": "array",
"items": {
"$ref": "#/components/schemas/ArtistFollowingRelationshipRemoveOperation_Payload_Data"
}
}
}
},
"ArtistFollowingRelationshipRemoveOperation_Payload_Data": {
"required": ["id", "type"],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["artists"]
}
}
},
"ArtistProfileArtRelationshipUpdateOperation_Payload": {
"required": ["data"],
"type": "object",
"properties": {
"data": {
"maxItems": 1,
"minItems": 0,
"type": "array",
"items": {
"$ref": "#/components/schemas/ArtistProfileArtRelationshipUpdateOperation_Payload_Data"
}
}
}
},
"ArtistProfileArtRelationshipUpdateOperation_Payload_Data": {
"required": ["id", "type"],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["artworks"]
}
}
},
"ArtistRoles_Attributes": {
"required": ["name"],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the artist role"
}
}
},
"ArtistRoles_Multi_Resource_Data_Document": {
"required": ["data", "links"],
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ArtistRoles_Resource_Object"
}
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"ArtistRoles_Resource_Object": {
"required": ["id", "type"],
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/ArtistRoles_Attributes"
},
"id": {
"type": "string",
"description": "Resource id",
"example": "12345"
},
"type": {
"minLength": 1,
"type": "string",
"description": "Resource type",
"example": "tracks"
}
}
},
"ArtistRoles_Single_Resource_Data_Document": {
"required": ["data", "links"],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ArtistRoles_Resource_Object"
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"ArtistUpdateBody": {
"required": ["data"],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ArtistUpdateBody_Data"
},
"meta": {
"$ref": "#/components/schemas/ArtistUpdateBody_Meta"
}
}
},
"ArtistUpdateBody_Data": {
"required": ["attributes", "id", "type"],
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/ArtistUpdateBody_Data_Attributes"
},
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["artists"]
}
}
},
"ArtistUpdateBody_Data_Attributes": {
"type": "object",
"properties": {
"contributionsEnabled": {
"type": "boolean"
},
"contributionsSalesPitch": {
"type": "string"
},
"externalLinks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/External_Link_Payload"
}
},
"handle": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"ArtistUpdateBody_Meta": {
"type": "object",
"properties": {
"dryRun": {
"type": "boolean"
}
}
},
"Artists_Attributes": {
"required": ["name", "popularity"],
"type": "object",
"properties": {
"contributionsEnabled": {
"type": "boolean",
"description": "Is the artist enabled for contributions?",
"example": true
},
"contributionsSalesPitch": {
"type": "string",
"description": "Contributions sales pitch",
"example": "Help me be a full time artist"
},
"externalLinks": {
"type": "array",
"description": "Artist links external to TIDAL API",
"items": {
"$ref": "#/components/schemas/External_Link"
}
},
"handle": {
"type": "string",
"description": "Artist handle",
"example": "jayz"
},
"name": {
"type": "string",
"description": "Artist name",
"example": "JAY Z"
},
"popularity": {
"type": "number",
"description": "Artist popularity (0.0 - 1.0)",
"format": "double",
"example": 0.56
},
"spotlighted": {
"type": "boolean",
"description": "Is the artist spotlighted?",
"example": true
}
}
},
"Artists_Followers_Multi_Relationship_Data_Document": {
"required": ["links"],
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Artists_Followers_Resource_Identifier"
}
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"Artists_Followers_Resource_Identifier": {
"required": ["id", "type"],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Resource id",
"example": "12345"
},
"meta": {
"$ref": "#/components/schemas/Artists_Followers_Resource_Identifier_Meta"
},
"type": {
"type": "string",
"description": "Resource type",
"example": "tracks"
}
}
},
"Artists_Followers_Resource_Identifier_Meta": {
"type": "object",
"properties": {
"viewer": {
"$ref": "#/components/schemas/Artists_Followers_Resource_Meta_ViewerContext"
}
}
},
"Artists_Followers_Resource_Meta_ViewerContext": {
"type": "object",
"properties": {
"followsMyArtist": {
"type": "boolean",
"description": "Boolean to indicate if the artist is following my artist",
"default": false
},
"myArtistFollows": {
"type": "boolean",
"description": "Boolean to indicate if my artist is following the artist",
"default": false
}
},
"description": "Optional context about the relationship"
},
"Artists_Following_Multi_Relationship_Data_Document": {
"required": ["links"],
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Artists_Following_Resource_Identifier"
}
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"Artists_Following_Resource_Identifier": {
"required": ["id", "type"],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Resource id",
"example": "12345"
},
"meta": {
"$ref": "#/components/schemas/Artists_Following_Resource_Identifier_Meta"
},
"type": {
"type": "string",
"description": "Resource type",
"example": "tracks"
}
}
},
"Artists_Following_Resource_Identifier_Meta": {
"type": "object",
"properties": {
"viewer": {
"$ref": "#/components/schemas/Artists_Followers_Resource_Meta_ViewerContext"
}
}
},
"Artists_Multi_Relationship_Data_Document": {
"required": ["links"],
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Resource_Identifier"
}
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"Artists_Multi_Resource_Data_Document": {
"required": ["data", "links"],
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Artists_Resource_Object"
}
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"Artists_Relationships": {
"required": [
"albums",
"biography",
"followers",
"following",
"owners",
"profileArt",
"radio",
"roles",
"similarArtists",
"trackProviders",
"tracks",
"videos"
],
"properties": {
"albums": {
"$ref": "#/components/schemas/Multi_Relationship_Data_Document"
},
"biography": {
"$ref": "#/components/schemas/Single_Relationship_Data_Document"
},
"followers": {
"$ref": "#/components/schemas/Artists_Followers_Multi_Relationship_Data_Document"
},
"following": {
"$ref": "#/components/schemas/Artists_Following_Multi_Relationship_Data_Document"
},
"owners": {
"$ref": "#/components/schemas/Multi_Relationship_Data_Document"
},
"profileArt": {
"$ref": "#/components/schemas/Multi_Relationship_Data_Document"
},
"radio": {
"$ref": "#/components/schemas/Multi_Relationship_Data_Document"
},
"roles": {
"$ref": "#/components/schemas/Multi_Relationship_Data_Document"
},
"similarArtists": {
"$ref": "#/components/schemas/Multi_Relationship_Data_Document"
},
"trackProviders": {
"$ref": "#/components/schemas/Artists_TrackProviders_Multi_Relationship_Data_Document"
},
"tracks": {
"$ref": "#/components/schemas/Multi_Relationship_Data_Document"
},
"videos": {
"$ref": "#/components/schemas/Multi_Relationship_Data_Document"
}
}
},
"Artists_Resource_Object": {
"required": ["id", "type"],
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/Artists_Attributes"
},
"id": {
"type": "string",
"description": "Resource id",
"example": "12345"
},
"relationships": {
"$ref": "#/components/schemas/Artists_Relationships"
},
"type": {
"minLength": 1,
"type": "string",
"description": "Resource type",
"example": "tracks"
}
}
},
"Artists_Single_Relationship_Data_Document": {
"required": ["links"],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Resource_Identifier"
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"Artists_Single_Resource_Data_Document": {
"required": ["data", "links"],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Artists_Resource_Object"
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"Artists_TrackProviders_Multi_Relationship_Data_Document": {
"required": ["links"],
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Artists_TrackProviders_Resource_Identifier"
}
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"Artists_TrackProviders_Resource_Identifier": {
"required": ["id", "type"],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Resource id",
"example": "12345"
},
"meta": {
"$ref": "#/components/schemas/Artists_TrackProviders_Resource_Identifier_Meta"
},
"type": {
"type": "string",
"description": "Resource type",
"example": "tracks"
}
}
},
"Artists_TrackProviders_Resource_Identifier_Meta": {
"required": ["numberOfTracks"],
"type": "object",
"properties": {
"numberOfTracks": {
"type": "integer",
"description": "Total number of tracks released together with the provider",
"format": "int64",
"example": 14
}
}
},
"ArtworkCreateOperation_Payload": {
"required": ["data"],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ArtworkCreateOperation_Payload_Data"
}
}
},
"ArtworkCreateOperation_Payload_Data": {
"required": ["attributes", "type"],
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/ArtworkCreateOperation_Payload_Data_Attributes"
},
"type": {
"type": "string",
"enum": ["artworks"]
}
}
},
"ArtworkCreateOperation_Payload_Data_Attributes": {
"required": ["mediaType", "sourceFile"],
"type": "object",
"properties": {
"mediaType": {
"type": "string",
"enum": ["IMAGE", "VIDEO"]
},
"sourceFile": {
"$ref": "#/components/schemas/ArtworkCreateOperation_Payload_Data_Attributes_SourceFile"
}
}
},
"ArtworkCreateOperation_Payload_Data_Attributes_SourceFile": {
"required": ["md5Hash", "size"],
"type": "object",
"properties": {
"md5Hash": {
"type": "string"
},
"size": {
"type": "integer",
"format": "int64"
}
}
},
"Artwork_File": {
"required": ["href"],
"type": "object",
"properties": {
"href": {
"type": "string",
"description": "Artwork file href"
},
"meta": {
"$ref": "#/components/schemas/Artwork_File_Meta"
}
},
"description": "Artwork files"
},
"Artwork_File_Meta": {
"required": ["height", "width"],
"type": "object",
"properties": {
"height": {
"type": "integer",
"description": "Height (in pixels)",
"format": "int32",
"example": 80
},
"width": {
"type": "integer",
"description": "Width (in pixels)",
"format": "int32",
"example": 80
}
},
"description": "Metadata about an artwork file"
},
"Artwork_SourceFile": {
"required": ["md5Hash", "size", "status", "uploadLink"],
"type": "object",
"properties": {
"md5Hash": {
"type": "string",
"description": "MD5 hash of file to be uploaded"
},
"size": {
"type": "integer",
"description": "File size of the artwork in bytes",
"format": "int64"
},
"status": {
"$ref": "#/components/schemas/File_Status"
},
"uploadLink": {
"$ref": "#/components/schemas/File_Upload_Link"
}
},
"description": "Artwork source file"
},
"Artworks_Attributes": {
"required": ["files", "mediaType"],
"type": "object",
"properties": {
"files": {
"type": "array",
"description": "Artwork files",
"items": {
"$ref": "#/components/schemas/Artwork_File"
}
},
"mediaType": {
"minLength": 1,
"type": "string",
"description": "Media type of artwork files",
"enum": ["IMAGE", "VIDEO"]
},
"sourceFile": {
"$ref": "#/components/schemas/Artwork_SourceFile"
}
}
},
"Artworks_Multi_Relationship_Data_Document": {
"required": ["links"],
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Resource_Identifier"
}
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"Artworks_Multi_Resource_Data_Document": {
"required": ["data", "links"],
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Artworks_Resource_Object"
}
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"Artworks_Relationships": {
"required": ["owners"],
"properties": {
"owners": {
"$ref": "#/components/schemas/Multi_Relationship_Data_Document"
}
}
},
"Artworks_Resource_Object": {
"required": ["id", "type"],
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/Artworks_Attributes"
},
"id": {
"type": "string",
"description": "Resource id",
"example": "12345"
},
"relationships": {
"$ref": "#/components/schemas/Artworks_Relationships"
},
"type": {
"minLength": 1,
"type": "string",
"description": "Resource type",
"example": "tracks"
}
}
},
"Artworks_Single_Resource_Data_Document": {
"required": ["data", "links"],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Artworks_Resource_Object"
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"AttachSourceFileToTrack": {
"required": ["id", "type"],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["tracks"]
}
}
},
"Attributes": {
"required": ["collectionType", "name"],
"type": "object",
"properties": {
"collectionType": {
"type": "string",
"enum": ["PLAYLISTS"]
},
"name": {
"type": "string"
}
}
},
"AudioNormalizationData": {
"type": "object",
"properties": {
"peakAmplitude": {
"type": "number",
"format": "float"
},
"replayGain": {
"type": "number",
"format": "float"
}
},
"description": "Track normalization data"
},
"BarcodeId": {
"required": ["value"],
"type": "object",
"properties": {
"value": {
"minLength": 1,
"type": "string"
}
},
"description": "Barcode Id",
"example": 196589525444
},
"Copyright": {
"required": ["text"],
"type": "object",
"properties": {
"text": {
"maxLength": 1024,
"minLength": 1,
"type": "string"
}
},
"description": "Copyright information"
},
"CreateReactionPayload": {
"required": ["data"],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/CreateReactionPayload_Data"
}
}
},
"CreateReactionPayload_Data": {
"required": ["attributes", "relationships", "type"],
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/CreateReactionPayload_Data_Attributes"
},
"relationships": {
"$ref": "#/components/schemas/CreateReactionPayload_Data_Relationships"
},
"type": {
"type": "string",
"enum": ["reactions"]
}
}
},
"CreateReactionPayload_Data_Attributes": {
"required": ["reactionType"],
"type": "object",
"properties": {
"reactionType": {
"type": "string",
"enum": [
"THUMB_UP",
"SMILEY_HEART_EYES",
"SMILEY_HOLDING_BACK_TEARS",
"FIRE",
"SHOCK"
]
}
}
},
"CreateReactionPayload_Data_Relationships": {
"required": ["reactedResource"],
"type": "object",
"properties": {
"reactedResource": {
"$ref": "#/components/schemas/ReactedResourceRelationship"
}
}
},
"Data": {
"required": ["id", "resourceType"],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"resourceType": {
"type": "string"
}
}
},
"Default400ResponseBody": {
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"detail": {
"type": "string",
"example": "The request is malformed or invalid"
},
"status": {
"type": "string",
"example": "400"
}
},
"required": ["status"]
}
}
},
"required": ["errors"]
},
"Default404ResponseBody": {
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"detail": {
"type": "string",
"example": "The requested resource was not found"
},
"status": {
"type": "string",
"example": "404"
}
},
"required": ["status"]
}
}
},
"required": ["errors"]
},
"Default405ResponseBody": {
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"detail": {
"type": "string",
"example": "The HTTP method is not allowed for the requested resource"
},
"status": {
"type": "string",
"example": "405"
}
},
"required": ["status"]
}
}
},
"required": ["errors"]
},
"Default406ResponseBody": {
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"detail": {
"type": "string",
"example": "A response that satisfies the content negotiation headers cannot be produced"
},
"status": {
"type": "string",
"example": "406"
}
},
"required": ["status"]
}
}
},
"required": ["errors"]
},
"Default415ResponseBody": {
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"detail": {
"type": "string",
"example": "Unsupported request payload media type or content encoding"
},
"status": {
"type": "string",
"example": "415"
}
},
"required": ["status"]
}
}
},
"required": ["errors"]
},
"Default429ResponseBody": {
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"detail": {
"type": "string",
"example": "Rate limit exceeded"
},
"status": {
"type": "string",
"example": "429"
}
},
"required": ["status"]
}
}
},
"required": ["errors"]
},
"Default500ResponseBody": {
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"detail": {
"type": "string",
"example": "An unexpected error was encountered"
},
"status": {
"type": "string",
"example": "500"
}
},
"required": ["status"]
}
}
},
"required": ["errors"]
},
"Default503ResponseBody": {
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"detail": {
"type": "string",
"example": "Temporarily unavailable; please try again later"
},
"status": {
"type": "string",
"example": "503"
}
},
"required": ["status"]
}
}
},
"required": ["errors"]
},
"DrmData": {
"type": "object",
"properties": {
"certificateUrl": {
"type": "string"
},
"drmSystem": {
"type": "string",
"enum": ["FAIRPLAY", "WIDEVINE"]
},
"licenseUrl": {
"type": "string"
}
},
"description": "DRM data. Absence implies no DRM."
},
"DynamicPages_Attributes": {
"required": ["pageType", "reportingId"],
"type": "object",
"properties": {
"pageType": {
"type": "string",
"description": "Type of the page eg. home, artist",
"example": "HOME_STATIC",
"enum": ["HOME_STATIC", "HOME_FOR_YOU", "HOME_EDITORIAL", "ARTIST"]
},
"reportingId": {
"type": "string",
"description": "Id used for reporting user events",
"format": "uuid",
"example": "83c92ac0-b8e3-4e28-9e27-07909dcde1e5"
}
}
},
"DynamicPages_Multi_Resource_Data_Document": {
"required": ["data", "links"],
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DynamicPages_Resource_Object"
}
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"DynamicPages_Relationships": {
"required": ["subject"],
"properties": {
"subject": {
"$ref": "#/components/schemas/Single_Relationship_Data_Document"
}
}
},
"DynamicPages_Resource_Object": {
"required": ["id", "type"],
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/DynamicPages_Attributes"
},
"id": {
"type": "string",
"description": "Resource id",
"example": "12345"
},
"relationships": {
"$ref": "#/components/schemas/DynamicPages_Relationships"
},
"type": {
"minLength": 1,
"type": "string",
"description": "Resource type",
"example": "tracks"
}
}
},
"DynamicPages_Single_Relationship_Data_Document": {
"required": ["links"],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Resource_Identifier"
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"DynamicPages_Single_Resource_Data_Document": {
"required": ["data", "links"],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/DynamicPages_Resource_Object"
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"Error_Object": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "application-specific error code"
},
"detail": {
"type": "string",
"description": "human-readable explanation specific to this occurrence of the problem"
},
"id": {
"type": "string",
"description": "unique identifier for this particular occurrence of the problem"
},
"source": {
"$ref": "#/components/schemas/Error_Object_Source"
},
"status": {
"type": "string",
"description": "HTTP status code applicable to this problem"
}
}
},
"Error_Object_Source": {
"type": "object",
"properties": {
"header": {
"type": "string",
"description": "string indicating the name of a single request header which caused the error",
"example": "X-some-custom-header"
},
"parameter": {
"type": "string",
"description": "string indicating which URI query parameter caused the error.",
"example": "countryCode"
},
"pointer": {
"type": "string",
"description": "a JSON Pointer [RFC6901] to the value in the request document that caused the error",
"example": "/data/attributes/title"
}
}
},
"Errors_Document": {
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "Array of error objects",
"items": {
"$ref": "#/components/schemas/Error_Object"
}
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"External_Link": {
"required": ["href", "meta"],
"type": "object",
"properties": {
"href": {
"type": "string"
},
"meta": {
"$ref": "#/components/schemas/External_Link_Meta"
}
}
},
"External_Link_Meta": {
"required": ["type"],
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"TIDAL_SHARING",
"TIDAL_USER_SHARING",
"TIDAL_AUTOPLAY_ANDROID",
"TIDAL_AUTOPLAY_IOS",
"TIDAL_AUTOPLAY_WEB",
"TWITTER",
"FACEBOOK",
"INSTAGRAM",
"TIKTOK",
"SNAPCHAT",
"OFFICIAL_HOMEPAGE",
"CASHAPP_CONTRIBUTIONS",
"ARTIST_CLAIM_PROVIDER_REDIRECT",
"STRIPE_AUTHORIZATION_REDIRECT"
]
}
},
"description": "metadata about an external link"
},
"External_Link_Payload": {
"required": ["meta"],
"type": "object",
"properties": {
"href": {
"type": "string"
},
"meta": {
"$ref": "#/components/schemas/External_Link_Meta"
}
}
},
"File_Status": {
"required": ["moderationFileStatus", "technicalFileStatus"],
"type": "object",
"properties": {
"moderationFileStatus": {
"type": "string",
"description": "Moderation status for file",
"enum": [
"NOT_MODERATED",
"SCANNING",
"FLAGGED",
"TAKEN_DOWN",
"OK",
"ERROR"
]
},
"technicalFileStatus": {
"type": "string",
"description": "Technical status for file",
"enum": ["UPLOAD_REQUESTED", "PROCESSING", "OK", "ERROR"]
}
},
"description": "File status"
},
"File_Upload_Link": {
"required": ["href", "meta"],
"type": "object",
"properties": {
"href": {
"type": "string",
"description": "Href to upload actual file to"
},
"meta": {
"$ref": "#/components/schemas/File_Upload_Link_Meta"
}
},
"description": "Upload link"
},
"File_Upload_Link_Meta": {
"required": ["method"],
"type": "object",
"properties": {
"headers": {
"type": "object",
"additionalProperties": {
"type": "string",
"description": "HTTP headers that must be added to the operation"
},
"description": "HTTP headers that must be added to the operation"
},
"method": {
"type": "string",
"description": "HTTP method"
}
},
"description": "metadata for upload link"
},
"FolderCreateOperation_Payload": {
"required": ["data"],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/FolderCreateOperation_Payload_Data"
}
}
},
"FolderCreateOperation_Payload_Data": {
"required": ["attributes", "type"],
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/Attributes"
},
"type": {
"type": "string",
"enum": ["userCollectionFolders"]
}
}
},
"FolderUpdateOperation_Payload": {
"required": ["data"],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/FolderUpdateOperation_Payload_Data"
}
}
},
"FolderUpdateOperation_Payload_Data": {
"required": ["attributes", "id", "type"],
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/Attributes"
},
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["userCollectionFolders"]
}
}
},
"Genres_Attributes": {
"required": ["genreName"],
"type": "object",
"properties": {
"genreName": {
"type": "string",
"description": "Genre name",
"example": "pop"
}
}
},
"Genres_Multi_Resource_Data_Document": {
"required": ["data", "links"],
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Genres_Resource_Object"
}
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"Genres_Resource_Object": {
"required": ["id", "type"],
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/Genres_Attributes"
},
"id": {
"type": "string",
"description": "Resource id",
"example": "12345"
},
"type": {
"minLength": 1,
"type": "string",
"description": "Resource type",
"example": "tracks"
}
}
},
"Genres_Single_Resource_Data_Document": {
"required": ["data", "links"],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Genres_Resource_Object"
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"Included": {
"type": "array",
"items": {
"discriminator": {
"mapping": {
"albums": "#/components/schemas/Albums_Resource_Object",
"appreciations": "#/components/schemas/Appreciations_Resource_Object",
"artistBiographies": "#/components/schemas/ArtistBiographies_Resource_Object",
"artistClaims": "#/components/schemas/ArtistClaims_Resource_Object",
"artistRoles": "#/components/schemas/ArtistRoles_Resource_Object",
"artists": "#/components/schemas/Artists_Resource_Object",
"artworks": "#/components/schemas/Artworks_Resource_Object",
"dynamicPages": "#/components/schemas/DynamicPages_Resource_Object",
"genres": "#/components/schemas/Genres_Resource_Object",
"lyrics": "#/components/schemas/Lyrics_Resource_Object",
"manualArtistClaims": "#/components/schemas/ManualArtistClaims_Resource_Object",
"playQueues": "#/components/schemas/PlayQueues_Resource_Object",
"playlists": "#/components/schemas/Playlists_Resource_Object",
"providers": "#/components/schemas/Providers_Resource_Object",
"reactions": "#/components/schemas/Reactions_Resource_Object",
"savedShares": "#/components/schemas/SavedShares_Resource_Object",
"searchResults": "#/components/schemas/SearchResults_Resource_Object",
"searchSuggestions": "#/components/schemas/SearchSuggestions_Resource_Object",
"shares": "#/components/schemas/Shares_Resource_Object",
"stripeConnections": "#/components/schemas/StripeConnections_Resource_Object",
"trackFiles": "#/components/schemas/TrackFiles_Resource_Object",
"trackManifests": "#/components/schemas/TrackManifests_Resource_Object",
"trackSourceFiles": "#/components/schemas/TrackSourceFiles_Resource_Object",
"trackStatistics": "#/components/schemas/TrackStatistics_Resource_Object",
"tracks": "#/components/schemas/Tracks_Resource_Object",
"userCollectionFolders": "#/components/schemas/UserCollectionFolders_Resource_Object",
"userCollections": "#/components/schemas/UserCollections_Resource_Object",
"userEntitlements": "#/components/schemas/UserEntitlements_Resource_Object",
"userRecommendations": "#/components/schemas/UserRecommendations_Resource_Object",
"userReports": "#/components/schemas/UserReports_Resource_Object",
"users": "#/components/schemas/Users_Resource_Object",
"videos": "#/components/schemas/Videos_Resource_Object"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/Albums_Resource_Object"
},
{
"$ref": "#/components/schemas/Appreciations_Resource_Object"
},
{
"$ref": "#/components/schemas/ArtistBiographies_Resource_Object"
},
{
"$ref": "#/components/schemas/ArtistClaims_Resource_Object"
},
{
"$ref": "#/components/schemas/ArtistRoles_Resource_Object"
},
{
"$ref": "#/components/schemas/Artists_Resource_Object"
},
{
"$ref": "#/components/schemas/Artworks_Resource_Object"
},
{
"$ref": "#/components/schemas/DynamicPages_Resource_Object"
},
{
"$ref": "#/components/schemas/Genres_Resource_Object"
},
{
"$ref": "#/components/schemas/Lyrics_Resource_Object"
},
{
"$ref": "#/components/schemas/ManualArtistClaims_Resource_Object"
},
{
"$ref": "#/components/schemas/PlayQueues_Resource_Object"
},
{
"$ref": "#/components/schemas/Playlists_Resource_Object"
},
{
"$ref": "#/components/schemas/Providers_Resource_Object"
},
{
"$ref": "#/components/schemas/Reactions_Resource_Object"
},
{
"$ref": "#/components/schemas/SavedShares_Resource_Object"
},
{
"$ref": "#/components/schemas/SearchResults_Resource_Object"
},
{
"$ref": "#/components/schemas/SearchSuggestions_Resource_Object"
},
{
"$ref": "#/components/schemas/Shares_Resource_Object"
},
{
"$ref": "#/components/schemas/StripeConnections_Resource_Object"
},
{
"$ref": "#/components/schemas/TrackFiles_Resource_Object"
},
{
"$ref": "#/components/schemas/TrackManifests_Resource_Object"
},
{
"$ref": "#/components/schemas/TrackSourceFiles_Resource_Object"
},
{
"$ref": "#/components/schemas/TrackStatistics_Resource_Object"
},
{
"$ref": "#/components/schemas/Tracks_Resource_Object"
},
{
"$ref": "#/components/schemas/UserCollectionFolders_Resource_Object"
},
{
"$ref": "#/components/schemas/UserCollections_Resource_Object"
},
{
"$ref": "#/components/schemas/UserEntitlements_Resource_Object"
},
{
"$ref": "#/components/schemas/UserRecommendations_Resource_Object"
},
{
"$ref": "#/components/schemas/UserReports_Resource_Object"
},
{
"$ref": "#/components/schemas/Users_Resource_Object"
},
{
"$ref": "#/components/schemas/Videos_Resource_Object"
}
]
}
},
"LegacySource": {
"required": ["id", "type"],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
}
}
},
"Links": {
"required": ["self"],
"type": "object",
"properties": {
"meta": {
"$ref": "#/components/schemas/Links_Meta"
},
"next": {
"type": "string",
"description": "Link to next page",
"example": "/artists/xyz/relationships/tracks?page[cursor]=zyx"
},
"self": {
"type": "string",
"description": "Link to self",
"example": "/artists/xyz/relationships/tracks"
}
}
},
"Links_Meta": {
"required": ["nextCursor"],
"type": "object",
"properties": {
"nextCursor": {
"type": "string",
"description": "Only cursor part of next link",
"example": "zyx"
}
},
"description": "Non-standard meta information for links"
},
"LyricsCreateOperation_Payload": {
"required": ["data"],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/LyricsCreateOperation_Payload_Data"
},
"meta": {
"$ref": "#/components/schemas/LyricsCreateOperation_Payload_Meta"
}
}
},
"LyricsCreateOperation_Payload_Data": {
"required": ["relationships", "type"],
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/LyricsCreateOperation_Payload_Data_Attributes"
},
"relationships": {
"$ref": "#/components/schemas/LyricsCreateOperation_Payload_Data_Relationships"
},
"type": {
"type": "string",
"enum": ["lyrics"]
}
}
},
"LyricsCreateOperation_Payload_Data_Attributes": {
"type": "object",
"properties": {
"text": {
"maxLength": 10000,
"minLength": 0,
"type": "string"
}
}
},
"LyricsCreateOperation_Payload_Data_Relationships": {
"required": ["track"],
"type": "object",
"properties": {
"track": {
"$ref": "#/components/schemas/LyricsCreateOperation_Payload_Data_Relationships_Track"
}
}
},
"LyricsCreateOperation_Payload_Data_Relationships_Track": {
"required": ["id", "type"],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["tracks"]
}
}
},
"LyricsCreateOperation_Payload_Meta": {
"type": "object",
"properties": {
"generate": {
"type": "boolean"
}
}
},
"LyricsProvider": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"source": {
"type": "string",
"enum": ["TIDAL", "THIRD_PARTY"]
}
},
"discriminator": {
"mapping": {
"THIRD_PARTY": "#/components/schemas/ThirdPartyLyricsProvider",
"TIDAL": "#/components/schemas/TidalLyricsProvider"
},
"propertyName": "source"
}
},
"LyricsUpdateOperation_Payload": {
"required": ["data"],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/LyricsUpdateOperation_Payload_Data"
}
}
},
"LyricsUpdateOperation_Payload_Data": {
"required": ["attributes", "id", "type"],
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/LyricsUpdateOperation_Payload_Data_Attributes"
},
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["lyrics"]
}
}
},
"LyricsUpdateOperation_Payload_Data_Attributes": {
"type": "object",
"properties": {
"lrcText": {
"type": "string"
},
"text": {
"maxLength": 10000,
"minLength": 0,
"type": "string"
}
}
},
"Lyrics_Attributes": {
"required": ["technicalStatus"],
"type": "object",
"properties": {
"direction": {
"type": "string",
"enum": ["LEFT_TO_RIGHT", "RIGHT_TO_LEFT"]
},
"lrcText": {
"type": "string"
},
"provider": {
"oneOf": [
{
"$ref": "#/components/schemas/ThirdPartyLyricsProvider"
},
{
"$ref": "#/components/schemas/TidalLyricsProvider"
}
]
},
"technicalStatus": {
"type": "string",
"enum": ["PENDING", "PROCESSING", "ERROR", "OK"]
},
"text": {
"type": "string"
}
}
},
"Lyrics_Multi_Relationship_Data_Document": {
"required": ["links"],
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Resource_Identifier"
}
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"Lyrics_Multi_Resource_Data_Document": {
"required": ["data", "links"],
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Lyrics_Resource_Object"
}
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"Lyrics_Relationships": {
"required": ["owners", "track"],
"properties": {
"owners": {
"$ref": "#/components/schemas/Multi_Relationship_Data_Document"
},
"track": {
"$ref": "#/components/schemas/Single_Relationship_Data_Document"
}
}
},
"Lyrics_Resource_Object": {
"required": ["id", "type"],
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/Lyrics_Attributes"
},
"id": {
"type": "string",
"description": "Resource id",
"example": "12345"
},
"relationships": {
"$ref": "#/components/schemas/Lyrics_Relationships"
},
"type": {
"minLength": 1,
"type": "string",
"description": "Resource type",
"example": "tracks"
}
}
},
"Lyrics_Single_Relationship_Data_Document": {
"required": ["links"],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Resource_Identifier"
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"Lyrics_Single_Resource_Data_Document": {
"required": ["data", "links"],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Lyrics_Resource_Object"
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"ManualArtistClaimsCreateOperation_Payload": {
"required": ["data"],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ManualArtistClaimsCreateOperation_Payload_Data"
}
}
},
"ManualArtistClaimsCreateOperation_Payload_Data": {
"required": ["attributes", "type"],
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/ManualArtistClaimsCreateOperation_Payload_Data_Attributes"
},
"type": {
"type": "string",
"enum": ["manualArtistClaims"]
}
}
},
"ManualArtistClaimsCreateOperation_Payload_Data_Attributes": {
"required": [
"artistId",
"legalFirstName",
"legalLastName",
"websiteOrSocialLink"
],
"type": "object",
"properties": {
"acceptedTerms": {
"type": "boolean"
},
"artistId": {
"type": "string"
},
"distributorName": {
"type": "string"
},
"errorReason": {
"type": "string"
},
"labelContactEmail": {
"type": "string"
},
"labelContactName": {
"type": "string"
},
"labelName": {
"type": "string"
},
"legalFirstName": {
"minLength": 1,
"type": "string"
},
"legalLastName": {
"minLength": 1,
"type": "string"
},
"managerEmail": {
"type": "string"
},
"managerName": {
"type": "string"
},
"role": {
"type": "string"
},
"selectedAlbums": {
"type": "array",
"items": {
"type": "string"
}
},
"selectedSingles": {
"type": "array",
"items": {
"type": "string"
}
},
"websiteOrSocialLink": {
"minLength": 1,
"type": "string"
}
}
},
"ManualArtistClaims_Attributes": {
"required": [
"artistId",
"legalFirstName",
"legalLastName",
"websiteOrSocialLink"
],
"type": "object",
"properties": {
"acceptedTerms": {
"type": "boolean",
"description": "Accepted terms and conditions"
},
"artistId": {
"type": "string",
"description": "Artist ID being claimed"
},
"createdAt": {
"type": "string",
"description": "Timestamp when the claim was created",
"format": "date-time"
},
"distributorName": {
"type": "string",
"description": "Distributor name"
},
"enrollmentType": {
"type": "string",
"description": "Enrollment type"
},
"errorReason": {
"type": "string",
"description": "Error reason if claim failed"
},
"labelContactEmail": {
"type": "string",
"description": "Label contact email"
},
"labelContactName": {
"type": "string",
"description": "Label contact name"
},
"labelName": {
"type": "string",
"description": "Label name"
},
"lastModifiedAt": {
"type": "string",
"description": "Timestamp when the claim was last modified",
"format": "date-time"
},
"legalFirstName": {
"minLength": 1,
"type": "string",
"description": "Legal first name"
},
"legalLastName": {
"minLength": 1,
"type": "string",
"description": "Legal last name"
},
"managerEmail": {
"type": "string",
"description": "Manager email"
},
"managerName": {
"type": "string",
"description": "Manager name"
},
"role": {
"type": "string",
"description": "Role"
},
"selectedAlbums": {
"type": "array",
"description": "Album IDs selected by user",
"items": {
"type": "string",
"description": "Album IDs selected by user"
}
},
"selectedSingles": {
"type": "array",
"description": "Single IDs selected by user",
"items": {
"type": "string",
"description": "Single IDs selected by user"
}
},
"status": {
"type": "string",
"description": "Claim status",
"enum": ["PENDING", "APPROVED", "REJECTED"]
},
"websiteOrSocialLink": {
"minLength": 1,
"type": "string",
"description": "Website or social link"
}
}
},
"ManualArtistClaims_Multi_Resource_Data_Document": {
"required": ["data", "links"],
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ManualArtistClaims_Resource_Object"
}
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"ManualArtistClaims_Resource_Object": {
"required": ["id", "type"],
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/ManualArtistClaims_Attributes"
},
"id": {
"type": "string",
"description": "Resource id",
"example": "12345"
},
"type": {
"minLength": 1,
"type": "string",
"description": "Resource type",
"example": "tracks"
}
}
},
"ManualArtistClaims_Single_Resource_Data_Document": {
"required": ["data", "links"],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ManualArtistClaims_Resource_Object"
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"Multi_Relationship_Data_Document": {
"required": ["links"],
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Resource_Identifier"
}
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"PlayQueueAddFutureOperation_Payload": {
"required": ["data"],
"type": "object",
"properties": {
"data": {
"maxItems": 20,
"minItems": 0,
"type": "array",
"items": {
"$ref": "#/components/schemas/PlayQueueAddFutureOperation_Payload_Data"
}
},
"meta": {
"$ref": "#/components/schemas/PlayQueueAddFutureOperation_Payload_Meta"
}
}
},
"PlayQueueAddFutureOperation_Payload_Data": {
"required": ["id", "type"],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["tracks", "videos", "albums", "playlists"]
}
}
},
"PlayQueueAddFutureOperation_Payload_Meta": {
"required": ["mode"],
"type": "object",
"properties": {
"batchId": {
"type": "string",
"format": "uuid"
},
"legacySource": {
"$ref": "#/components/schemas/LegacySource"
},
"mode": {
"type": "string",
"enum": ["ADD_TO_FRONT", "ADD_TO_BACK", "ADD_BEFORE", "REPLACE_ALL"]
},
"positionBefore": {
"type": "string"
}
}
},
"PlayQueueCreateOperation_Payload": {
"required": ["data"],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/PlayQueueCreateOperation_Payload_Data"
}
}
},
"PlayQueueCreateOperation_Payload_Data": {
"required": ["type"],
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["playQueues"]
}
}
},
"PlayQueueRemoveFutureOperation_Payload": {
"required": ["data"],
"type": "object",
"properties": {
"data": {
"maxItems": 20,
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/PlayQueueRemoveFutureOperation_Payload_Data"
}
}
}
},
"PlayQueueRemoveFutureOperation_Payload_Data": {
"required": ["id", "meta", "type"],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"meta": {
"$ref": "#/components/schemas/PlayQueueUpdateRemoveOperation_Payload_Data_Meta"
},
"type": {
"type": "string",
"enum": ["tracks", "videos"]
}
}
},
"PlayQueueUpdateCurrentOperations_Payload": {
"required": ["data"],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/PlayQueueUpdateCurrentOperations_Payload_Data"
}
}
},
"PlayQueueUpdateCurrentOperations_Payload_Data": {
"required": ["id", "meta", "type"],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"meta": {
"$ref": "#/components/schemas/PlayQueueUpdateCurrentOperations_Payload_Data_Meta"
},
"type": {
"type": "string",
"enum": ["tracks", "videos"]
}
}
},
"PlayQueueUpdateCurrentOperations_Payload_Data_Meta": {
"required": ["itemId"],
"type": "object",
"properties": {
"itemId": {
"type": "string"
}
}
},
"PlayQueueUpdateFutureOperation_Payload": {
"required": ["data", "meta"],
"type": "object",
"properties": {
"data": {
"maxItems": 20,
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/PlayQueueUpdateFutureOperation_Payload_Data"
}
},
"meta": {
"$ref": "#/components/schemas/PlayQueueUpdateFutureOperation_Payload_Meta"
}
}
},
"PlayQueueUpdateFutureOperation_Payload_Data": {
"required": ["id", "meta", "type"],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"meta": {
"$ref": "#/components/schemas/PlayQueueUpdateFutureOperation_Payload_Data_Meta"
},
"type": {
"type": "string",
"enum": ["tracks", "videos"]
}
}
},
"PlayQueueUpdateFutureOperation_Payload_Data_Meta": {
"required": ["itemId"],
"type": "object",
"properties": {
"itemId": {
"type": "string"
}
}
},
"PlayQueueUpdateFutureOperation_Payload_Meta": {
"required": ["positionBefore"],
"type": "object",
"properties": {
"positionBefore": {
"type": "string"
}
}
},
"PlayQueueUpdateOperation_Payload": {
"required": ["data"],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/PlayQueueUpdateOperation_Payload_Data"
}
}
},
"PlayQueueUpdateOperation_Payload_Data": {
"required": ["attributes", "id", "type"],
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/PlayQueueUpdateOperation_Payload_Data_Attributes"
},
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["playQueues"]
}
}
},
"PlayQueueUpdateOperation_Payload_Data_Attributes": {
"type": "object",
"properties": {
"repeat": {
"type": "string",
"enum": ["NONE", "ONE", "BATCH"]
},
"shuffled": {
"type": "boolean"
}
}
},
"PlayQueueUpdateRemoveOperation_Payload_Data_Meta": {
"required": ["itemId"],
"type": "object",
"properties": {
"itemId": {
"type": "string"
}
}
},
"PlayQueues_Attributes": {
"required": ["createdAt", "lastModifiedAt", "repeat", "shuffled"],
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"description": "ISO 8601 creation timestamp",
"format": "date-time"
},
"lastModifiedAt": {
"type": "string",
"description": "ISO 8601 last modified timestamp",
"format": "date-time"
},
"repeat": {
"type": "string",
"description": "Queue's repeat mode",
"enum": ["NONE", "ONE", "BATCH"]
},
"shuffled": {
"type": "boolean",
"description": "Queue is shuffled or not"
}
}
},
"PlayQueues_Current_Resource_Identifier": {
"required": ["id", "type"],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Resource id",
"example": "12345"
},
"meta": {
"$ref": "#/components/schemas/PlayQueues_Current_Resource_Identifier_Meta"
},
"type": {
"type": "string",
"description": "Resource type",
"example": "tracks"
}
}
},
"PlayQueues_Current_Resource_Identifier_Meta": {
"required": ["batchId", "itemId"],
"type": "object",
"properties": {
"batchId": {
"type": "string",
"format": "uuid"
},
"itemId": {
"minLength": 1,
"type": "string"
},
"legacySource": {
"$ref": "#/components/schemas/LegacySource"
}
}
},
"PlayQueues_Current_Single_Relationship_Data_Document": {
"required": ["links"],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/PlayQueues_Current_Resource_Identifier"
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"PlayQueues_Future_Multi_Relationship_Data_Document": {
"required": ["links"],
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PlayQueues_Future_Resource_Identifier"
}
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"PlayQueues_Future_Resource_Identifier": {
"required": ["id", "type"],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Resource id",
"example": "12345"
},
"meta": {
"$ref": "#/components/schemas/PlayQueues_Future_Resource_Identifier_Meta"
},
"type": {
"type": "string",
"description": "Resource type",
"example": "tracks"
}
}
},
"PlayQueues_Future_Resource_Identifier_Meta": {
"required": ["batchId", "itemId"],
"type": "object",
"properties": {
"batchId": {
"type": "string",
"format": "uuid"
},
"itemId": {
"minLength": 1,
"type": "string"
},
"legacySource": {
"$ref": "#/components/schemas/LegacySource"
}
}
},
"PlayQueues_Multi_Relationship_Data_Document": {
"required": ["links"],
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Resource_Identifier"
}
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"PlayQueues_Multi_Resource_Data_Document": {
"required": ["data", "links"],
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PlayQueues_Resource_Object"
}
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"PlayQueues_Past_Multi_Relationship_Data_Document": {
"required": ["links"],
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PlayQueues_Past_Resource_Identifier"
}
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"PlayQueues_Past_Resource_Identifier": {
"required": ["id", "type"],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Resource id",
"example": "12345"
},
"meta": {
"$ref": "#/components/schemas/PlayQueues_Past_Resource_Identifier_Meta"
},
"type": {
"type": "string",
"description": "Resource type",
"example": "tracks"
}
}
},
"PlayQueues_Past_Resource_Identifier_Meta": {
"required": ["batchId", "itemId"],
"type": "object",
"properties": {
"batchId": {
"type": "string",
"format": "uuid"
},
"itemId": {
"minLength": 1,
"type": "string"
},
"legacySource": {
"$ref": "#/components/schemas/LegacySource"
}
}
},
"PlayQueues_Relationships": {
"required": ["current", "future", "owners", "past"],
"properties": {
"current": {
"$ref": "#/components/schemas/PlayQueues_Current_Single_Relationship_Data_Document"
},
"future": {
"$ref": "#/components/schemas/PlayQueues_Future_Multi_Relationship_Data_Document"
},
"owners": {
"$ref": "#/components/schemas/Multi_Relationship_Data_Document"
},
"past": {
"$ref": "#/components/schemas/PlayQueues_Past_Multi_Relationship_Data_Document"
}
}
},
"PlayQueues_Resource_Object": {
"required": ["id", "type"],
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/PlayQueues_Attributes"
},
"id": {
"type": "string",
"description": "Resource id",
"example": "12345"
},
"relationships": {
"$ref": "#/components/schemas/PlayQueues_Relationships"
},
"type": {
"minLength": 1,
"type": "string",
"description": "Resource type",
"example": "tracks"
}
}
},
"PlayQueues_Single_Relationship_Data_Document": {
"required": ["links"],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Resource_Identifier"
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"PlayQueues_Single_Resource_Data_Document": {
"required": ["data", "links"],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/PlayQueues_Resource_Object"
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"PlaylistCoverArtRelationshipUpdateOperation_Payload": {
"required": ["data"],
"type": "object",
"properties": {
"data": {
"maxItems": 1,
"minItems": 0,
"type": "array",
"items": {
"$ref": "#/components/schemas/PlaylistCoverArtRelationshipUpdateOperation_Payload_Data"
}
}
}
},
"PlaylistCoverArtRelationshipUpdateOperation_Payload_Data": {
"required": ["id", "type"],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["artworks"]
}
}
},
"PlaylistCreateOperation_Payload": {
"required": ["data"],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/PlaylistCreateOperation_Payload_Data"
}
}
},
"PlaylistCreateOperation_Payload_Data": {
"required": ["attributes", "type"],
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/PlaylistCreateOperation_Payload_Data_Attributes"
},
"type": {
"type": "string",
"enum": ["playlists"]
}
}
},
"PlaylistCreateOperation_Payload_Data_Attributes": {
"required": ["name"],
"type": "object",
"properties": {
"accessType": {
"type": "string",
"description": "Access type",
"example": "PUBLIC",
"enum": ["PUBLIC", "UNLISTED"]
},
"description": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"PlaylistItemsRelationshipAddOperation_Payload": {
"required": ["data"],
"type": "object",
"properties": {
"data": {
"maxItems": 20,
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/PlaylistItemsRelationshipAddOperation_Payload_Data"
}
},
"meta": {
"$ref": "#/components/schemas/PlaylistItemsRelationshipAddOperation_Payload_Meta"
}
}
},
"PlaylistItemsRelationshipAddOperation_Payload_Data": {
"required": ["id", "type"],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"meta": {
"$ref": "#/components/schemas/PlaylistItemsRelationshipAddOperation_Payload_Data_Meta"
},
"type": {
"type": "string",
"enum": ["tracks", "videos"]
}
}
},
"PlaylistItemsRelationshipAddOperation_Payload_Data_Meta": {
"type": "object",
"properties": {
"addedAt": {
"type": "string",
"format": "date-time"
}
}
},
"PlaylistItemsRelationshipAddOperation_Payload_Meta": {
"required": ["positionBefore"],
"type": "object",
"properties": {
"positionBefore": {
"type": "string"
}
}
},
"PlaylistItemsRelationshipRemoveOperation_Payload": {
"required": ["data"],
"type": "object",
"properties": {
"data": {
"maxItems": 20,
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/PlaylistItemsRelationshipRemoveOperation_Payload_Data"
}
}
}
},
"PlaylistItemsRelationshipRemoveOperation_Payload_Data": {
"required": ["id", "meta", "type"],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"meta": {
"$ref": "#/components/schemas/PlaylistItemsRelationshipRemoveOperation_Payload_Data_Meta"
},
"type": {
"type": "string",
"enum": ["tracks", "videos"]
}
}
},
"PlaylistItemsRelationshipRemoveOperation_Payload_Data_Meta": {
"required": ["itemId"],
"type": "object",
"properties": {
"itemId": {
"type": "string"
}
}
},
"PlaylistItemsRelationshipReorderOperation_Payload": {
"required": ["data"],
"type": "object",
"properties": {
"data": {
"maxItems": 20,
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/PlaylistItemsRelationshipReorderOperation_Payload_Data"
}
},
"meta": {
"$ref": "#/components/schemas/PlaylistItemsRelationshipReorderOperation_Payload_Meta"
}
}
},
"PlaylistItemsRelationshipReorderOperation_Payload_Data": {
"required": ["id", "meta", "type"],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"meta": {
"$ref": "#/components/schemas/PlaylistItemsRelationshipReorderOperation_Payload_Data_Meta"
},
"type": {
"type": "string",
"enum": ["tracks", "videos"]
}
}
},
"PlaylistItemsRelationshipReorderOperation_Payload_Data_Meta": {
"required": ["itemId"],
"type": "object",
"properties": {
"itemId": {
"type": "string"
}
}
},
"PlaylistItemsRelationshipReorderOperation_Payload_Meta": {
"required": ["positionBefore"],
"type": "object",
"properties": {
"positionBefore": {
"type": "string"
}
}
},
"PlaylistUpdateOperation_Payload": {
"required": ["data"],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/PlaylistUpdateOperation_Payload_Data"
}
}
},
"PlaylistUpdateOperation_Payload_Data": {
"required": ["attributes", "id", "type"],
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/PlaylistUpdateOperation_Payload_Data_Attributes"
},
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["playlists"]
}
}
},
"PlaylistUpdateOperation_Payload_Data_Attributes": {
"type": "object",
"properties": {
"accessType": {
"type": "string",
"description": "Access type",
"example": "PUBLIC",
"enum": ["PUBLIC", "UNLISTED"]
},
"description": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"Playlists_Attributes": {
"required": [
"accessType",
"bounded",
"createdAt",
"externalLinks",
"lastModifiedAt",
"name",
"numberOfFollowers",
"playlistType"
],
"type": "object",
"properties": {
"accessType": {
"type": "string",
"description": "Access type",
"example": "PUBLIC",
"enum": ["PUBLIC", "UNLISTED"]
},
"bounded": {
"type": "boolean",
"description": "Indicates if the playlist has a duration and set number of tracks"
},
"createdAt": {
"type": "string",
"description": "Datetime of playlist creation (ISO 8601)",
"format": "date-time"
},
"description": {
"type": "string",
"description": "Playlist description"
},
"duration": {
"type": "string",
"description": "Duration of playlist (ISO 8601)",
"example": "P30M5S"
},
"externalLinks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/External_Link"
}
},
"lastModifiedAt": {
"type": "string",
"description": "Datetime of last modification of the playlist (ISO 8601)",
"format": "date-time"
},
"name": {
"minLength": 1,
"type": "string",
"description": "Playlist name"
},
"numberOfFollowers": {
"type": "integer",
"description": "The amount of followers of the playlist",
"format": "int32"
},
"numberOfItems": {
"type": "integer",
"description": "Number of items in the playlist",
"format": "int32"
},
"playlistType": {
"type": "string",
"description": "The type of the playlist",
"enum": ["EDITORIAL", "USER", "MIX", "ARTIST"]
}
}
},
"Playlists_Items_Multi_Relationship_Data_Document": {
"required": ["links"],
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Playlists_Items_Resource_Identifier"
}
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"Playlists_Items_Resource_Identifier": {
"required": ["id", "type"],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Resource id",
"example": "12345"
},
"meta": {
"$ref": "#/components/schemas/Playlists_Items_Resource_Identifier_Meta"
},
"type": {
"type": "string",
"description": "Resource type",
"example": "tracks"
}
}
},
"Playlists_Items_Resource_Identifier_Meta": {
"type": "object",
"properties": {
"addedAt": {
"type": "string",
"format": "date-time"
},
"itemId": {
"type": "string"
}
}
},
"Playlists_Multi_Relationship_Data_Document": {
"required": ["links"],
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Resource_Identifier"
}
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"Playlists_Multi_Resource_Data_Document": {
"required": ["data", "links"],
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Playlists_Resource_Object"
}
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"Playlists_Relationships": {
"required": ["coverArt", "items", "ownerProfiles", "owners"],
"properties": {
"coverArt": {
"$ref": "#/components/schemas/Multi_Relationship_Data_Document"
},
"items": {
"$ref": "#/components/schemas/Playlists_Items_Multi_Relationship_Data_Document"
},
"ownerProfiles": {
"$ref": "#/components/schemas/Multi_Relationship_Data_Document"
},
"owners": {
"$ref": "#/components/schemas/Multi_Relationship_Data_Document"
}
}
},
"Playlists_Resource_Object": {
"required": ["id", "type"],
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/Playlists_Attributes"
},
"id": {
"type": "string",
"description": "Resource id",
"example": "12345"
},
"relationships": {
"$ref": "#/components/schemas/Playlists_Relationships"
},
"type": {
"minLength": 1,
"type": "string",
"description": "Resource type",
"example": "tracks"
}
}
},
"Playlists_Single_Resource_Data_Document": {
"required": ["data", "links"],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Playlists_Resource_Object"
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"Providers_Attributes": {
"required": ["name"],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Provider name",
"example": "Columbia/Legacy"
}
}
},
"Providers_Multi_Resource_Data_Document": {
"required": ["data", "links"],
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Providers_Resource_Object"
}
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"Providers_Resource_Object": {
"required": ["id", "type"],
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/Providers_Attributes"
},
"id": {
"type": "string",
"description": "Resource id",
"example": "12345"
},
"type": {
"minLength": 1,
"type": "string",
"description": "Resource type",
"example": "tracks"
}
}
},
"Providers_Single_Resource_Data_Document": {
"required": ["data", "links"],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Providers_Resource_Object"
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"ReactedResourceIdentifier": {
"required": ["id", "type"],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["albums", "tracks", "artists", "videos", "playlists"]
}
}
},
"ReactedResourceRelationship": {
"required": ["data"],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ReactedResourceIdentifier"
}
}
},
"Reactions_Attributes": {
"required": ["createdAt", "reactionType"],
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"description": "Datetime of the reaction creation (ISO 8601)",
"format": "date-time",
"example": "2025-11-17T12:54:48.60606Z"
},
"reactionType": {
"type": "string",
"description": "The type of reaction representing an emoji",
"enum": [
"THUMB_UP",
"SMILEY_HEART_EYES",
"SMILEY_HOLDING_BACK_TEARS",
"FIRE",
"SHOCK"
]
}
}
},
"Reactions_Multi_Relationship_Data_Document": {
"required": ["links"],
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Resource_Identifier"
}
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"Reactions_Multi_Resource_Data_Document": {
"required": ["data", "links"],
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Reactions_Resource_Object"
}
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"Reactions_Relationships": {
"required": ["ownerProfiles"],
"properties": {
"ownerProfiles": {
"$ref": "#/components/schemas/Multi_Relationship_Data_Document"
}
}
},
"Reactions_Resource_Object": {
"required": ["id", "type"],
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/Reactions_Attributes"
},
"id": {
"type": "string",
"description": "Resource id",
"example": "12345"
},
"relationships": {
"$ref": "#/components/schemas/Reactions_Relationships"
},
"type": {
"minLength": 1,
"type": "string",
"description": "Resource type",
"example": "tracks"
}
}
},
"Reactions_Single_Resource_Data_Document": {
"required": ["data", "links"],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Reactions_Resource_Object"
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"RemovePayload": {
"type": "object",
"properties": {
"data": {
"maxItems": 10,
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/Data"
}
}
}
},
"Resource_Identifier": {
"required": ["id", "type"],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Resource id",
"example": "12345"
},
"type": {
"type": "string",
"description": "Resource type",
"example": "tracks"
}
}
},
"Resource_ObjectObjectObject": {
"required": ["id", "type"],
"type": "object",
"properties": {
"attributes": {
"type": "object"
},
"id": {
"type": "string",
"description": "Resource id",
"example": "12345"
},
"relationships": {
"type": "object"
},
"type": {
"minLength": 1,
"type": "string",
"description": "Resource type",
"example": "tracks"
}
}
},
"SavedSharesCreateOperation_Payload": {
"required": ["data"],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/SavedSharesCreateOperation_Payload_Data"
}
}
},
"SavedSharesCreateOperation_Payload_Data": {
"required": ["relationships", "type"],
"type": "object",
"properties": {
"relationships": {
"$ref": "#/components/schemas/SavedSharesCreateOperation_Payload_Data_Relationships"
},
"type": {
"type": "string",
"enum": ["savedShares"]
}
}
},
"SavedSharesCreateOperation_Payload_Data_Relationships": {
"required": ["share"],
"type": "object",
"properties": {
"share": {
"$ref": "#/components/schemas/SavedSharesCreateOperation_Payload_Data_Relationships_Share"
}
}
},
"SavedSharesCreateOperation_Payload_Data_Relationships_Share": {
"required": ["data"],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/SavedSharesCreateOperation_Payload_Data_Relationships_Share_Data"
}
}
},
"SavedSharesCreateOperation_Payload_Data_Relationships_Share_Data": {
"required": ["id", "type"],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["shares"]
}
}
},
"SavedShares_Attributes": {
"required": ["createdAt"],
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"description": "Datetime of saved share creation (ISO 8601)",
"format": "date-time"
}
}
},
"SavedShares_Multi_Resource_Data_Document": {
"required": ["data", "links"],
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SavedShares_Resource_Object"
}
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"SavedShares_Resource_Object": {
"required": ["id", "type"],
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/SavedShares_Attributes"
},
"id": {
"type": "string",
"description": "Resource id",
"example": "12345"
},
"type": {
"minLength": 1,
"type": "string",
"description": "Resource type",
"example": "tracks"
}
}
},
"SavedShares_Single_Resource_Data_Document": {
"required": ["data", "links"],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/SavedShares_Resource_Object"
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"SearchResults_Attributes": {
"required": ["trackingId"],
"type": "object",
"properties": {
"didYouMean": {
"type": "string",
"description": "'did you mean' prompt",
"example": "beatles"
},
"trackingId": {
"type": "string",
"description": "search request unique tracking number",
"example": "5896e37d-e847-4ca6-9629-ef8001719f7f"
}
}
},
"SearchResults_Multi_Relationship_Data_Document": {
"required": ["links"],
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Resource_Identifier"
}
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"SearchResults_Multi_Resource_Data_Document": {
"required": ["data", "links"],
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SearchResults_Resource_Object"
}
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"SearchResults_Relationships": {
"required": [
"albums",
"artists",
"playlists",
"topHits",
"tracks",
"videos"
],
"properties": {
"albums": {
"$ref": "#/components/schemas/Multi_Relationship_Data_Document"
},
"artists": {
"$ref": "#/components/schemas/Multi_Relationship_Data_Document"
},
"playlists": {
"$ref": "#/components/schemas/Multi_Relationship_Data_Document"
},
"topHits": {
"$ref": "#/components/schemas/Multi_Relationship_Data_Document"
},
"tracks": {
"$ref": "#/components/schemas/Multi_Relationship_Data_Document"
},
"videos": {
"$ref": "#/components/schemas/Multi_Relationship_Data_Document"
}
}
},
"SearchResults_Resource_Object": {
"required": ["id", "type"],
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/SearchResults_Attributes"
},
"id": {
"type": "string",
"description": "Resource id",
"example": "12345"
},
"relationships": {
"$ref": "#/components/schemas/SearchResults_Relationships"
},
"type": {
"minLength": 1,
"type": "string",
"description": "Resource type",
"example": "tracks"
}
}
},
"SearchResults_Single_Resource_Data_Document": {
"required": ["data", "links"],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/SearchResults_Resource_Object"
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"SearchSuggestions_Attributes": {
"required": ["trackingId"],
"type": "object",
"properties": {
"history": {
"type": "array",
"description": "Suggestions from search history",
"items": {
"$ref": "#/components/schemas/SearchSuggestions_History"
}
},
"suggestions": {
"type": "array",
"description": "Suggested search queries",
"items": {
"$ref": "#/components/schemas/SearchSuggestions_Suggestions"
}
},
"trackingId": {
"minLength": 1,
"type": "string",
"description": "Unique tracking id"
}
}
},
"SearchSuggestions_Highlights": {
"required": ["length", "start"],
"type": "object",
"properties": {
"length": {
"type": "integer",
"format": "int32"
},
"start": {
"type": "integer",
"format": "int32"
}
}
},
"SearchSuggestions_History": {
"required": ["query"],
"type": "object",
"properties": {
"highlights": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SearchSuggestions_Highlights"
}
},
"query": {
"minLength": 1,
"type": "string"
}
},
"description": "Suggestions from search history"
},
"SearchSuggestions_Multi_Relationship_Data_Document": {
"required": ["links"],
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Resource_Identifier"
}
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"SearchSuggestions_Multi_Resource_Data_Document": {
"required": ["data", "links"],
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SearchSuggestions_Resource_Object"
}
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"SearchSuggestions_Relationships": {
"required": ["directHits"],
"properties": {
"directHits": {
"$ref": "#/components/schemas/Multi_Relationship_Data_Document"
}
}
},
"SearchSuggestions_Resource_Object": {
"required": ["id", "type"],
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/SearchSuggestions_Attributes"
},
"id": {
"type": "string",
"description": "Resource id",
"example": "12345"
},
"relationships": {
"$ref": "#/components/schemas/SearchSuggestions_Relationships"
},
"type": {
"minLength": 1,
"type": "string",
"description": "Resource type",
"example": "tracks"
}
}
},
"SearchSuggestions_Single_Resource_Data_Document": {
"required": ["data", "links"],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/SearchSuggestions_Resource_Object"
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"SearchSuggestions_Suggestions": {
"required": ["query"],
"type": "object",
"properties": {
"highlights": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SearchSuggestions_Highlights"
}
},
"query": {
"minLength": 1,
"type": "string"
}
},
"description": "Suggested search queries"
},
"SharesCreateOperation_Payload": {
"required": ["data"],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/SharesCreateOperation_Payload_Data"
}
}
},
"SharesCreateOperation_Payload_Data": {
"required": ["relationships", "type"],
"type": "object",
"properties": {
"relationships": {
"$ref": "#/components/schemas/SharesCreateOperation_Payload_Data_Relationships"
},
"type": {
"type": "string",
"enum": ["shares"]
}
}
},
"SharesCreateOperation_Payload_Data_Relationships": {
"required": ["sharedResources"],
"type": "object",
"properties": {
"sharedResources": {
"$ref": "#/components/schemas/SharesCreateOperation_Payload_Data_Relationships_SharedResources"
}
}
},
"SharesCreateOperation_Payload_Data_Relationships_SharedResources": {
"required": ["data"],
"type": "object",
"properties": {
"data": {
"maxItems": 1,
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/SharesCreateOperation_Payload_Data_Relationships_SharedResources_Data"
}
}
}
},
"SharesCreateOperation_Payload_Data_Relationships_SharedResources_Data": {
"required": ["id", "type"],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["tracks", "albums"]
}
}
},
"Shares_Attributes": {
"required": ["code", "createdAt"],
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Share code"
},
"createdAt": {
"type": "string",
"description": "Datetime of share creation (ISO 8601)",
"format": "date-time"
},
"externalLinks": {
"type": "array",
"description": "Links external to TIDAL API",
"items": {
"$ref": "#/components/schemas/External_Link"
}
}
}
},
"Shares_Multi_Relationship_Data_Document": {
"required": ["links"],
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Resource_Identifier"
}
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"Shares_Multi_Resource_Data_Document": {
"required": ["data", "links"],
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Shares_Resource_Object"
}
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"Shares_Relationships": {
"required": ["owners", "sharedResources"],
"properties": {
"owners": {
"$ref": "#/components/schemas/Multi_Relationship_Data_Document"
},
"sharedResources": {
"$ref": "#/components/schemas/Multi_Relationship_Data_Document"
}
}
},
"Shares_Resource_Object": {
"required": ["id", "type"],
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/Shares_Attributes"
},
"id": {
"type": "string",
"description": "Resource id",
"example": "12345"
},
"relationships": {
"$ref": "#/components/schemas/Shares_Relationships"
},
"type": {
"minLength": 1,
"type": "string",
"description": "Resource type",
"example": "tracks"
}
}
},
"Shares_Single_Resource_Data_Document": {
"required": ["data", "links"],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Shares_Resource_Object"
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"Single_Relationship_Data_Document": {
"required": ["links"],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Resource_Identifier"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"StripeConnectionsCreateOperation_Payload": {
"required": ["data"],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/StripeConnectionsCreateOperation_Payload_Data"
}
}
},
"StripeConnectionsCreateOperation_Payload_Data": {
"required": ["attributes", "type"],
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/StripeConnectionsCreateOperation_Payload_Data_Attributes"
},
"type": {
"type": "string",
"enum": ["stripeConnections"]
}
}
},
"StripeConnectionsCreateOperation_Payload_Data_Attributes": {
"required": ["integrationType"],
"type": "object",
"properties": {
"integrationType": {
"type": "string",
"description": "Integration type for Stripe onboarding",
"example": "REDIRECT",
"enum": ["REDIRECT", "EMBEDDED"],
"default": "REDIRECT"
},
"refreshUrl": {
"type": "string",
"description": "REDIRECT only: URL to redirect to if seller drops from onboarding",
"example": "https://www.tidal.com/artist/upload/onboarding"
},
"returnUrl": {
"type": "string",
"description": "REDIRECT only: URL to redirect to after completed onboarding",
"example": "https://www.tidal.com/artist/124"
}
}
},
"StripeConnections_Attributes": {
"required": ["status"],
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"description": "Timestamp when the connection was created",
"format": "date-time"
},
"externalLinks": {
"type": "array",
"description": "External links for Stripe connection",
"items": {
"$ref": "#/components/schemas/External_Link"
}
},
"lastModifiedAt": {
"type": "string",
"description": "Timestamp when the connection was last modified",
"format": "date-time"
},
"status": {
"minLength": 1,
"type": "string",
"description": "Current status of this Stripe connection",
"enum": [
"PENDING_REQUIREMENTS",
"UNDER_REVIEW",
"ACCEPTED",
"REJECTED"
]
}
}
},
"StripeConnections_Multi_Relationship_Data_Document": {
"required": ["links"],
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Resource_Identifier"
}
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"StripeConnections_Multi_Resource_Data_Document": {
"required": ["data", "links"],
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StripeConnections_Resource_Object"
}
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"StripeConnections_Relationships": {
"required": ["owners"],
"properties": {
"owners": {
"$ref": "#/components/schemas/Multi_Relationship_Data_Document"
}
}
},
"StripeConnections_Resource_Object": {
"required": ["id", "type"],
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/StripeConnections_Attributes"
},
"id": {
"type": "string",
"description": "Resource id",
"example": "12345"
},
"relationships": {
"$ref": "#/components/schemas/StripeConnections_Relationships"
},
"type": {
"minLength": 1,
"type": "string",
"description": "Resource type",
"example": "tracks"
}
}
},
"StripeConnections_Single_Resource_Data_Document": {
"required": ["data", "links"],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/StripeConnections_Resource_Object"
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"ThirdPartyLyricsProvider": {
"required": ["commonTrackId", "lyricsId", "name"],
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/LyricsProvider"
},
{
"type": "object",
"properties": {
"commonTrackId": {
"type": "string"
},
"lyricsId": {
"type": "string"
}
}
}
]
},
"TidalLyricsProvider": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/LyricsProvider"
}
]
},
"TrackAlbumsRelationshipUpdateOperation_Payload": {
"required": ["data"],
"type": "object",
"properties": {
"data": {
"maxItems": 1,
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/TrackAlbumsRelationshipUpdateOperation_Payload_Data"
}
}
}
},
"TrackAlbumsRelationshipUpdateOperation_Payload_Data": {
"required": ["id", "type"],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["albums"]
}
}
},
"TrackCreateOperation_Payload": {
"required": ["data"],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/TrackCreateOperation_Payload_Data"
}
}
},
"TrackCreateOperation_Payload_Data": {
"required": ["attributes", "relationships", "type"],
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/TrackCreateOperation_Payload_Data_Attributes"
},
"relationships": {
"$ref": "#/components/schemas/TrackCreateOperation_Payload_Data_Relationships"
},
"type": {
"type": "string",
"enum": ["tracks"]
}
}
},
"TrackCreateOperation_Payload_Data_Attributes": {
"required": ["accessType", "title"],
"type": "object",
"properties": {
"accessType": {
"type": "string",
"description": "Access type",
"example": "PRIVATE",
"enum": ["PUBLIC", "UNLISTED", "PRIVATE"]
},
"explicit": {
"type": "boolean",
"description": "Explicit content",
"example": false
},
"title": {
"type": "string"
}
}
},
"TrackCreateOperation_Payload_Data_Relationships": {
"required": ["albums", "artists"],
"type": "object",
"properties": {
"albums": {
"$ref": "#/components/schemas/TrackCreateOperation_Payload_Data_Relationships_Albums"
},
"artists": {
"$ref": "#/components/schemas/TrackCreateOperation_Payload_Data_Relationships_Artists"
},
"genres": {
"$ref": "#/components/schemas/TrackCreateOperation_Payload_Data_Relationships_Genres"
}
}
},
"TrackCreateOperation_Payload_Data_Relationships_Albums": {
"required": ["data"],
"type": "object",
"properties": {
"data": {
"maxItems": 1,
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/TrackCreateOperation_Payload_Data_Relationships_Albums_Data"
}
}
}
},
"TrackCreateOperation_Payload_Data_Relationships_Albums_Data": {
"required": ["id", "type"],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["albums"]
}
}
},
"TrackCreateOperation_Payload_Data_Relationships_Artists": {
"required": ["data"],
"type": "object",
"properties": {
"data": {
"maxItems": 1,
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/TrackCreateOperation_Payload_Data_Relationships_Artists_Data"
}
}
}
},
"TrackCreateOperation_Payload_Data_Relationships_Artists_Data": {
"required": ["id", "type"],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["artists"]
}
}
},
"TrackCreateOperation_Payload_Data_Relationships_Genres": {
"required": ["data"],
"type": "object",
"properties": {
"data": {
"maxItems": 3,
"minItems": 0,
"type": "array",
"items": {
"$ref": "#/components/schemas/TrackCreateOperation_Payload_Data_Relationships_Genres_Data"
}
}
}
},
"TrackCreateOperation_Payload_Data_Relationships_Genres_Data": {
"required": ["id", "type"],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["genres"]
}
}
},
"TrackFilesReadById403ResponseBody": {
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string",
"example": "CLIENT_NOT_ENTITLED",
"enum": [
"CLIENT_NOT_ENTITLED",
"CONCURRENT_PLAYBACK",
"GEO_RESTRICTED",
"PREREQUISITE_MISSING",
"PURCHASE_REQUIRED"
]
},
"detail": {
"type": "string",
"example": "Cannot fulfill this request because required prerequisites are missing"
},
"status": {
"type": "string",
"example": "403"
}
},
"required": ["code", "status"]
}
}
},
"required": ["errors"]
},
"TrackFilesReadById404ResponseBody": {
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string",
"example": "CONTENT_NOT_FOUND",
"enum": ["CONTENT_NOT_FOUND"]
},
"detail": {
"type": "string",
"example": "The requested content does not exist or is no longer available"
},
"status": {
"type": "string",
"example": "404"
}
},
"required": ["code", "status"]
}
}
},
"required": ["errors"]
},
"TrackFiles_Attributes": {
"type": "object",
"properties": {
"albumAudioNormalizationData": {
"$ref": "#/components/schemas/AudioNormalizationData"
},
"format": {
"type": "string",
"description": "File's audio format",
"enum": ["HEAACV1", "AACLC", "FLAC", "FLAC_HIRES", "EAC3_JOC"]
},
"trackAudioNormalizationData": {
"$ref": "#/components/schemas/AudioNormalizationData"
},
"trackPresentation": {
"type": "string",
"description": "Track presentation",
"enum": ["FULL", "PREVIEW"]
},
"url": {
"type": "string",
"description": "File URL"
}
}
},
"TrackFiles_Multi_Resource_Data_Document": {
"required": ["data", "links"],
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TrackFiles_Resource_Object"
}
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"TrackFiles_Resource_Object": {
"required": ["id", "type"],
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/TrackFiles_Attributes"
},
"id": {
"type": "string",
"description": "Resource id",
"example": "12345"
},
"type": {
"minLength": 1,
"type": "string",
"description": "Resource type",
"example": "tracks"
}
}
},
"TrackFiles_Single_Resource_Data_Document": {
"required": ["data", "links"],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/TrackFiles_Resource_Object"
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"TrackManifestsReadById403ResponseBody": {
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string",
"example": "CLIENT_NOT_ENTITLED",
"enum": [
"CLIENT_NOT_ENTITLED",
"CONCURRENT_PLAYBACK",
"GEO_RESTRICTED",
"PREREQUISITE_MISSING",
"PURCHASE_REQUIRED"
]
},
"detail": {
"type": "string",
"example": "Cannot fulfill this request because required prerequisites are missing"
},
"status": {
"type": "string",
"example": "403"
}
},
"required": ["code", "status"]
}
}
},
"required": ["errors"]
},
"TrackManifestsReadById404ResponseBody": {
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string",
"example": "CONTENT_NOT_FOUND",
"enum": ["CONTENT_NOT_FOUND"]
},
"detail": {
"type": "string",
"example": "The requested content does not exist or is no longer available"
},
"status": {
"type": "string",
"example": "404"
}
},
"required": ["code", "status"]
}
}
},
"required": ["errors"]
},
"TrackManifests_Attributes": {
"type": "object",
"properties": {
"albumAudioNormalizationData": {
"$ref": "#/components/schemas/AudioNormalizationData"
},
"drmData": {
"$ref": "#/components/schemas/DrmData"
},
"formats": {
"type": "array",
"description": "Formats present in manifest",
"items": {
"type": "string",
"description": "Formats present in manifest",
"enum": ["HEAACV1", "AACLC", "FLAC", "FLAC_HIRES", "EAC3_JOC"]
}
},
"hash": {
"type": "string",
"description": "Unique manifest hash"
},
"trackAudioNormalizationData": {
"$ref": "#/components/schemas/AudioNormalizationData"
},
"trackPresentation": {
"type": "string",
"description": "Track presentation",
"enum": ["FULL", "PREVIEW"]
},
"uri": {
"type": "string",
"description": "Manifest URI"
}
}
},
"TrackManifests_Multi_Resource_Data_Document": {
"required": ["data", "links"],
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TrackManifests_Resource_Object"
}
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"TrackManifests_Resource_Object": {
"required": ["id", "type"],
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/TrackManifests_Attributes"
},
"id": {
"type": "string",
"description": "Resource id",
"example": "12345"
},
"type": {
"minLength": 1,
"type": "string",
"description": "Resource type",
"example": "tracks"
}
}
},
"TrackManifests_Single_Resource_Data_Document": {
"required": ["data", "links"],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/TrackManifests_Resource_Object"
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"TrackSourceFileCreateOperation_Payload": {
"required": ["data"],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/TrackSourceFileCreateOperation_Payload_Data"
}
}
},
"TrackSourceFileCreateOperation_Payload_Data": {
"required": ["attributes", "relationships", "type"],
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/TrackSourceFileCreateOperation_Payload_Data_Attributes"
},
"relationships": {
"$ref": "#/components/schemas/TrackSourceFileCreateOperation_Payload_Data_Relationships"
},
"type": {
"type": "string",
"enum": ["trackSourceFiles"]
}
}
},
"TrackSourceFileCreateOperation_Payload_Data_Attributes": {
"required": ["md5Hash", "size"],
"type": "object",
"properties": {
"md5Hash": {
"type": "string"
},
"size": {
"type": "integer",
"format": "int64"
}
}
},
"TrackSourceFileCreateOperation_Payload_Data_Relationships": {
"required": ["track"],
"type": "object",
"properties": {
"track": {
"$ref": "#/components/schemas/AttachSourceFileToTrack"
}
}
},
"TrackSourceFiles_Attributes": {
"required": ["md5Hash", "size", "status", "uploadLink"],
"type": "object",
"properties": {
"md5Hash": {
"type": "string",
"description": "MD5 hash of file to be uploaded"
},
"size": {
"type": "integer",
"description": "File size of the track in bytes",
"format": "int64"
},
"status": {
"$ref": "#/components/schemas/File_Status"
},
"uploadLink": {
"$ref": "#/components/schemas/File_Upload_Link"
}
}
},
"TrackSourceFiles_Multi_Relationship_Data_Document": {
"required": ["links"],
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Resource_Identifier"
}
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"TrackSourceFiles_Multi_Resource_Data_Document": {
"required": ["data", "links"],
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TrackSourceFiles_Resource_Object"
}
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"TrackSourceFiles_Relationships": {
"required": ["owners"],
"properties": {
"owners": {
"$ref": "#/components/schemas/Multi_Relationship_Data_Document"
}
}
},
"TrackSourceFiles_Resource_Object": {
"required": ["id", "type"],
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/TrackSourceFiles_Attributes"
},
"id": {
"type": "string",
"description": "Resource id",
"example": "12345"
},
"relationships": {
"$ref": "#/components/schemas/TrackSourceFiles_Relationships"
},
"type": {
"minLength": 1,
"type": "string",
"description": "Resource type",
"example": "tracks"
}
}
},
"TrackSourceFiles_Single_Resource_Data_Document": {
"required": ["data", "links"],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/TrackSourceFiles_Resource_Object"
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"TrackStatistics_Attributes": {
"required": ["totalPlaybacks", "uniqueListeners"],
"type": "object",
"properties": {
"totalPlaybacks": {
"type": "integer",
"description": "Total playbacks",
"format": "int32"
},
"uniqueListeners": {
"type": "integer",
"description": "Unique listeners",
"format": "int32"
}
}
},
"TrackStatistics_Multi_Relationship_Data_Document": {
"required": ["links"],
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Resource_Identifier"
}
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"TrackStatistics_Multi_Resource_Data_Document": {
"required": ["data", "links"],
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TrackStatistics_Resource_Object"
}
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"TrackStatistics_Relationships": {
"required": ["owners"],
"properties": {
"owners": {
"$ref": "#/components/schemas/Multi_Relationship_Data_Document"
}
}
},
"TrackStatistics_Resource_Object": {
"required": ["id", "type"],
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/TrackStatistics_Attributes"
},
"id": {
"type": "string",
"description": "Resource id",
"example": "12345"
},
"relationships": {
"$ref": "#/components/schemas/TrackStatistics_Relationships"
},
"type": {
"minLength": 1,
"type": "string",
"description": "Resource type",
"example": "tracks"
}
}
},
"TrackStatistics_Single_Resource_Data_Document": {
"required": ["data", "links"],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/TrackStatistics_Resource_Object"
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"TrackUpdateOperation_Payload": {
"required": ["data"],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/TrackUpdateOperation_Payload_Data"
}
}
},
"TrackUpdateOperation_Payload_Data": {
"required": ["id", "type"],
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/TrackUpdateOperation_Payload_Data_Attributes"
},
"id": {
"type": "string"
},
"relationships": {
"$ref": "#/components/schemas/TrackUpdateOperation_Payload_Data_Relationships"
},
"type": {
"type": "string",
"enum": ["tracks"]
}
}
},
"TrackUpdateOperation_Payload_Data_Attributes": {
"type": "object",
"properties": {
"accessType": {
"type": "string",
"description": "Access type",
"example": "PRIVATE",
"enum": ["PUBLIC", "UNLISTED", "PRIVATE"]
},
"bpm": {
"type": "number",
"format": "float"
},
"explicit": {
"type": "boolean",
"description": "Explicit content",
"example": false
},
"key": {
"type": "string",
"enum": [
"UNKNOWN",
"C",
"CSharp",
"D",
"Eb",
"E",
"F",
"FSharp",
"G",
"Ab",
"A",
"Bb",
"B"
]
},
"keyScale": {
"type": "string",
"enum": [
"UNKNOWN",
"MAJOR",
"MINOR",
"AEOLIAN",
"BLUES",
"DORIAN",
"HARMONIC_MINOR",
"LOCRIAN",
"LYDIAN",
"MIXOLYDIAN",
"PENTATONIC_MAJOR",
"PHRYGIAN",
"MELODIC_MINOR",
"PENTATONIC_MINOR"
]
},
"title": {
"type": "string"
},
"toneTags": {
"maxItems": 5,
"minItems": 0,
"type": "array",
"items": {
"maxLength": 20,
"minLength": 1,
"type": "string",
"description": "Tone tags",
"example": "happy"
}
}
}
},
"TrackUpdateOperation_Payload_Data_Relationships": {
"type": "object",
"properties": {
"genres": {
"$ref": "#/components/schemas/TrackUpdateOperation_Payload_Data_Relationships_Genres"
}
}
},
"TrackUpdateOperation_Payload_Data_Relationships_Genres": {
"required": ["data"],
"type": "object",
"properties": {
"data": {
"maxItems": 3,
"minItems": 0,
"type": "array",
"items": {
"$ref": "#/components/schemas/TrackUpdateOperation_Payload_Data_Relationships_Genres_Data"
}
}
}
},
"TrackUpdateOperation_Payload_Data_Relationships_Genres_Data": {
"required": ["id", "type"],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["genres"]
}
}
},
"Tracks_Attributes": {
"required": [
"duration",
"explicit",
"isrc",
"key",
"keyScale",
"mediaTags",
"popularity",
"title"
],
"type": "object",
"properties": {
"accessType": {
"type": "string",
"description": "Access type",
"example": "PRIVATE",
"enum": ["PUBLIC", "UNLISTED", "PRIVATE"]
},
"availability": {
"type": "array",
"description": "Available usage for this track",
"items": {
"type": "string",
"enum": ["STREAM", "DJ", "STEM"]
}
},
"bpm": {
"type": "number",
"description": "Beats per minute",
"format": "float",
"example": 60.0
},
"copyright": {
"$ref": "#/components/schemas/Copyright"
},
"createdAt": {
"type": "string",
"description": "Datetime of track creation (ISO 8601)",
"format": "date-time"
},
"duration": {
"type": "string",
"description": "Duration (ISO 8601)",
"example": "PT2M58S"
},
"explicit": {
"type": "boolean",
"description": "Explicit content",
"example": false
},
"externalLinks": {
"type": "array",
"description": "Track links external to TIDAL API",
"items": {
"$ref": "#/components/schemas/External_Link"
}
},
"isrc": {
"type": "string",
"description": "International Standard Recording Code (ISRC)",
"example": "QMJMT1701229"
},
"key": {
"type": "string",
"description": "Key",
"enum": [
"UNKNOWN",
"C",
"CSharp",
"D",
"Eb",
"E",
"F",
"FSharp",
"G",
"Ab",
"A",
"Bb",
"B"
]
},
"keyScale": {
"type": "string",
"description": "The scale of the key",
"enum": [
"UNKNOWN",
"MAJOR",
"MINOR",
"AEOLIAN",
"BLUES",
"DORIAN",
"HARMONIC_MINOR",
"LOCRIAN",
"LYDIAN",
"MIXOLYDIAN",
"PENTATONIC_MAJOR",
"PHRYGIAN",
"MELODIC_MINOR",
"PENTATONIC_MINOR"
]
},
"mediaTags": {
"type": "array",
"items": {
"type": "string",
"description": "Media metadata tags",
"example": "HIRES_LOSSLESS"
}
},
"popularity": {
"type": "number",
"description": "Popularity (0.0 - 1.0)",
"format": "double",
"example": 0.56
},
"spotlighted": {
"type": "boolean",
"description": "Is the track spotlighted?",
"example": true
},
"title": {
"type": "string",
"description": "Track title",
"example": "Kill Jay Z"
},
"toneTags": {
"type": "array",
"items": {
"type": "string",
"description": "Tone tags",
"example": "Happy"
}
},
"version": {
"type": "string",
"description": "Track version, complements title",
"example": "original, mix etc"
}
}
},
"Tracks_Multi_Relationship_Data_Document": {
"required": ["links"],
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Resource_Identifier"
}
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"Tracks_Multi_Resource_Data_Document": {
"required": ["data", "links"],
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Tracks_Resource_Object"
}
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"Tracks_Relationships": {
"required": [
"albums",
"artists",
"genres",
"lyrics",
"owners",
"providers",
"radio",
"replacement",
"shares",
"similarTracks",
"sourceFile",
"trackStatistics"
],
"properties": {
"albums": {
"$ref": "#/components/schemas/Multi_Relationship_Data_Document"
},
"artists": {
"$ref": "#/components/schemas/Multi_Relationship_Data_Document"
},
"genres": {
"$ref": "#/components/schemas/Multi_Relationship_Data_Document"
},
"lyrics": {
"$ref": "#/components/schemas/Multi_Relationship_Data_Document"
},
"owners": {
"$ref": "#/components/schemas/Multi_Relationship_Data_Document"
},
"providers": {
"$ref": "#/components/schemas/Multi_Relationship_Data_Document"
},
"radio": {
"$ref": "#/components/schemas/Multi_Relationship_Data_Document"
},
"replacement": {
"$ref": "#/components/schemas/Single_Relationship_Data_Document"
},
"shares": {
"$ref": "#/components/schemas/Multi_Relationship_Data_Document"
},
"similarTracks": {
"$ref": "#/components/schemas/Multi_Relationship_Data_Document"
},
"sourceFile": {
"$ref": "#/components/schemas/Single_Relationship_Data_Document"
},
"trackStatistics": {
"$ref": "#/components/schemas/Single_Relationship_Data_Document"
}
}
},
"Tracks_Resource_Object": {
"required": ["id", "type"],
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/Tracks_Attributes"
},
"id": {
"type": "string",
"description": "Resource id",
"example": "12345"
},
"relationships": {
"$ref": "#/components/schemas/Tracks_Relationships"
},
"type": {
"minLength": 1,
"type": "string",
"description": "Resource type",
"example": "tracks"
}
}
},
"Tracks_Single_Relationship_Data_Document": {
"required": ["links"],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Resource_Identifier"
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"Tracks_Single_Resource_Data_Document": {
"required": ["data", "links"],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Tracks_Resource_Object"
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"UserCollectionAlbumsRelationshipAddOperation_Payload": {
"required": ["data"],
"type": "object",
"properties": {
"data": {
"maxItems": 20,
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/UserCollectionAlbumsRelationshipAddOperation_Payload_Data"
}
}
}
},
"UserCollectionAlbumsRelationshipAddOperation_Payload_Data": {
"required": ["id", "type"],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"meta": {
"$ref": "#/components/schemas/UserCollectionAlbumsRelationshipAddOperation_Payload_Data_Meta"
},
"type": {
"type": "string",
"enum": ["albums"]
}
}
},
"UserCollectionAlbumsRelationshipAddOperation_Payload_Data_Meta": {
"type": "object",
"properties": {
"addedAt": {
"type": "string",
"format": "date-time"
}
}
},
"UserCollectionAlbumsRelationshipRemoveOperation_Payload": {
"required": ["data"],
"type": "object",
"properties": {
"data": {
"maxItems": 20,
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/UserCollectionAlbumsRelationshipRemoveOperation_Payload_Data"
}
}
}
},
"UserCollectionAlbumsRelationshipRemoveOperation_Payload_Data": {
"required": ["id", "type"],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["albums"]
}
}
},
"UserCollectionArtistsRelationshipAddOperation_Payload": {
"required": ["data"],
"type": "object",
"properties": {
"data": {
"maxItems": 20,
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/UserCollectionArtistsRelationshipAddOperation_Payload_Data"
}
}
}
},
"UserCollectionArtistsRelationshipAddOperation_Payload_Data": {
"required": ["id", "type"],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"meta": {
"$ref": "#/components/schemas/UserCollectionArtistsRelationshipAddOperation_Payload_Data_Meta"
},
"type": {
"type": "string",
"enum": ["artists"]
}
}
},
"UserCollectionArtistsRelationshipAddOperation_Payload_Data_Meta": {
"type": "object",
"properties": {
"addedAt": {
"type": "string",
"format": "date-time"
}
}
},
"UserCollectionArtistsRelationshipRemoveOperation_Payload": {
"required": ["data"],
"type": "object",
"properties": {
"data": {
"maxItems": 20,
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/UserCollectionArtistsRelationshipRemoveOperation_Payload_Data"
}
}
}
},
"UserCollectionArtistsRelationshipRemoveOperation_Payload_Data": {
"required": ["id", "type"],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["artists"]
}
}
},
"UserCollectionFolders_Attributes": {
"required": ["collectionType", "createdAt", "lastModifiedAt", "name"],
"type": "object",
"properties": {
"collectionType": {
"type": "string",
"enum": ["PLAYLISTS"]
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"lastModifiedAt": {
"type": "string",
"format": "date-time"
},
"name": {
"type": "string"
},
"numberOfItems": {
"type": "integer",
"format": "int32"
}
}
},
"UserCollectionFolders_Items_Multi_Relationship_Data_Document": {
"required": ["links"],
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserCollectionFolders_Items_Resource_Identifier"
}
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"UserCollectionFolders_Items_Resource_Identifier": {
"required": ["id", "type"],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Resource id",
"example": "12345"
},
"meta": {
"$ref": "#/components/schemas/UserCollectionFolders_Items_Resource_Identifier_Meta"
},
"type": {
"type": "string",
"description": "Resource type",
"example": "tracks"
}
}
},
"UserCollectionFolders_Items_Resource_Identifier_Meta": {
"required": ["addedAt", "lastModifiedAt"],
"type": "object",
"properties": {
"addedAt": {
"type": "string",
"format": "date-time"
},
"lastModifiedAt": {
"type": "string",
"format": "date-time"
}
}
},
"UserCollectionFolders_Multi_Relationship_Data_Document": {
"required": ["links"],
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Resource_Identifier"
}
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"UserCollectionFolders_Multi_Resource_Data_Document": {
"required": ["data", "links"],
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserCollectionFolders_Resource_Object"
}
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"UserCollectionFolders_Relationships": {
"required": ["items", "owners"],
"properties": {
"items": {
"$ref": "#/components/schemas/UserCollectionFolders_Items_Multi_Relationship_Data_Document"
},
"owners": {
"$ref": "#/components/schemas/Multi_Relationship_Data_Document"
}
}
},
"UserCollectionFolders_Resource_Object": {
"required": ["id", "type"],
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/UserCollectionFolders_Attributes"
},
"id": {
"type": "string",
"description": "Resource id",
"example": "12345"
},
"relationships": {
"$ref": "#/components/schemas/UserCollectionFolders_Relationships"
},
"type": {
"minLength": 1,
"type": "string",
"description": "Resource type",
"example": "tracks"
}
}
},
"UserCollectionFolders_Single_Resource_Data_Document": {
"required": ["data", "links"],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/UserCollectionFolders_Resource_Object"
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"UserCollectionPlaylistsRelationshipRemoveOperation_Payload": {
"required": ["data"],
"type": "object",
"properties": {
"data": {
"maxItems": 20,
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/UserCollectionPlaylistsRelationshipRemoveOperation_Payload_Data"
}
}
}
},
"UserCollectionPlaylistsRelationshipRemoveOperation_Payload_Data": {
"required": ["id", "type"],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["playlists"]
}
}
},
"UserCollectionTracksRelationshipAddOperation_Payload": {
"required": ["data"],
"type": "object",
"properties": {
"data": {
"maxItems": 20,
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/UserCollectionTracksRelationshipAddOperation_Payload_Data"
}
}
}
},
"UserCollectionTracksRelationshipAddOperation_Payload_Data": {
"required": ["id", "type"],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"meta": {
"$ref": "#/components/schemas/UserCollectionTracksRelationshipAddOperation_Payload_Data_Meta"
},
"type": {
"type": "string",
"enum": ["tracks"]
}
}
},
"UserCollectionTracksRelationshipAddOperation_Payload_Data_Meta": {
"type": "object",
"properties": {
"addedAt": {
"type": "string",
"format": "date-time"
}
}
},
"UserCollectionTracksRelationshipRemoveOperation_Payload": {
"required": ["data"],
"type": "object",
"properties": {
"data": {
"maxItems": 20,
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/UserCollectionTracksRelationshipRemoveOperation_Payload_Data"
}
}
}
},
"UserCollectionTracksRelationshipRemoveOperation_Payload_Data": {
"required": ["id", "type"],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["tracks"]
}
}
},
"UserCollectionVideosRelationshipAddOperation_Payload": {
"required": ["data"],
"type": "object",
"properties": {
"data": {
"maxItems": 20,
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/UserCollectionVideosRelationshipAddOperation_Payload_Data"
}
}
}
},
"UserCollectionVideosRelationshipAddOperation_Payload_Data": {
"required": ["id", "type"],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["videos"]
}
}
},
"UserCollectionVideosRelationshipRemoveOperation_Payload": {
"required": ["data"],
"type": "object",
"properties": {
"data": {
"maxItems": 20,
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/UserCollectionVideosRelationshipRemoveOperation_Payload_Data"
}
}
}
},
"UserCollectionVideosRelationshipRemoveOperation_Payload_Data": {
"required": ["id", "type"],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["videos"]
}
}
},
"UserCollections_Albums_Multi_Relationship_Data_Document": {
"required": ["links"],
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserCollections_Albums_Resource_Identifier"
}
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"UserCollections_Albums_Resource_Identifier": {
"required": ["id", "type"],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Resource id",
"example": "12345"
},
"meta": {
"$ref": "#/components/schemas/UserCollections_Albums_Resource_Identifier_Meta"
},
"type": {
"type": "string",
"description": "Resource type",
"example": "tracks"
}
}
},
"UserCollections_Albums_Resource_Identifier_Meta": {
"required": ["addedAt"],
"type": "object",
"properties": {
"addedAt": {
"type": "string",
"format": "date-time"
}
}
},
"UserCollections_Artists_Multi_Relationship_Data_Document": {
"required": ["links"],
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserCollections_Artists_Resource_Identifier"
}
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"UserCollections_Artists_Resource_Identifier": {
"required": ["id", "type"],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Resource id",
"example": "12345"
},
"meta": {
"$ref": "#/components/schemas/UserCollections_Artists_Resource_Identifier_Meta"
},
"type": {
"type": "string",
"description": "Resource type",
"example": "tracks"
}
}
},
"UserCollections_Artists_Resource_Identifier_Meta": {
"required": ["addedAt"],
"type": "object",
"properties": {
"addedAt": {
"type": "string",
"format": "date-time"
}
}
},
"UserCollections_Attributes": {
"type": "object"
},
"UserCollections_Multi_Relationship_Data_Document": {
"required": ["links"],
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Resource_Identifier"
}
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"UserCollections_Multi_Resource_Data_Document": {
"required": ["data", "links"],
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserCollections_Resource_Object"
}
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"UserCollections_Playlists_Multi_Relationship_Data_Document": {
"required": ["links"],
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserCollections_Playlists_Resource_Identifier"
}
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"UserCollections_Playlists_Resource_Identifier": {
"required": ["id", "type"],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Resource id",
"example": "12345"
},
"meta": {
"$ref": "#/components/schemas/UserCollections_Playlists_Resource_Identifier_Meta"
},
"type": {
"type": "string",
"description": "Resource type",
"example": "tracks"
}
}
},
"UserCollections_Playlists_Resource_Identifier_Meta": {
"required": ["addedAt"],
"type": "object",
"properties": {
"addedAt": {
"type": "string",
"format": "date-time"
}
}
},
"UserCollections_Relationships": {
"required": [
"albums",
"artists",
"owners",
"playlists",
"tracks",
"videos"
],
"properties": {
"albums": {
"$ref": "#/components/schemas/UserCollections_Albums_Multi_Relationship_Data_Document"
},
"artists": {
"$ref": "#/components/schemas/UserCollections_Artists_Multi_Relationship_Data_Document"
},
"owners": {
"$ref": "#/components/schemas/Multi_Relationship_Data_Document"
},
"playlists": {
"$ref": "#/components/schemas/UserCollections_Playlists_Multi_Relationship_Data_Document"
},
"tracks": {
"$ref": "#/components/schemas/UserCollections_Tracks_Multi_Relationship_Data_Document"
},
"videos": {
"$ref": "#/components/schemas/UserCollections_Videos_Multi_Relationship_Data_Document"
}
}
},
"UserCollections_Resource_Object": {
"required": ["id", "type"],
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/UserCollections_Attributes"
},
"id": {
"type": "string",
"description": "Resource id",
"example": "12345"
},
"relationships": {
"$ref": "#/components/schemas/UserCollections_Relationships"
},
"type": {
"minLength": 1,
"type": "string",
"description": "Resource type",
"example": "tracks"
}
}
},
"UserCollections_Single_Resource_Data_Document": {
"required": ["data", "links"],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/UserCollections_Resource_Object"
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"UserCollections_Tracks_Multi_Relationship_Data_Document": {
"required": ["links"],
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserCollections_Tracks_Resource_Identifier"
}
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"UserCollections_Tracks_Resource_Identifier": {
"required": ["id", "type"],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Resource id",
"example": "12345"
},
"meta": {
"$ref": "#/components/schemas/UserCollections_Tracks_Resource_Identifier_Meta"
},
"type": {
"type": "string",
"description": "Resource type",
"example": "tracks"
}
}
},
"UserCollections_Tracks_Resource_Identifier_Meta": {
"required": ["addedAt"],
"type": "object",
"properties": {
"addedAt": {
"type": "string",
"format": "date-time"
}
}
},
"UserCollections_Videos_Multi_Relationship_Data_Document": {
"required": ["links"],
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserCollections_Videos_Resource_Identifier"
}
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"UserCollections_Videos_Resource_Identifier": {
"required": ["id", "type"],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Resource id",
"example": "12345"
},
"meta": {
"$ref": "#/components/schemas/UserCollections_Videos_Resource_Identifier_Meta"
},
"type": {
"type": "string",
"description": "Resource type",
"example": "tracks"
}
}
},
"UserCollections_Videos_Resource_Identifier_Meta": {
"required": ["addedAt"],
"type": "object",
"properties": {
"addedAt": {
"type": "string",
"format": "date-time"
}
}
},
"UserEntitlements_Attributes": {
"required": ["entitlements"],
"type": "object",
"properties": {
"entitlements": {
"type": "array",
"description": "Entitlements for user",
"items": {
"type": "string",
"description": "Entitlements for user",
"enum": ["MUSIC", "DJ"]
}
}
}
},
"UserEntitlements_Multi_Relationship_Data_Document": {
"required": ["links"],
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Resource_Identifier"
}
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"UserEntitlements_Multi_Resource_Data_Document": {
"required": ["data", "links"],
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserEntitlements_Resource_Object"
}
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"UserEntitlements_Relationships": {
"required": ["owners"],
"properties": {
"owners": {
"$ref": "#/components/schemas/Multi_Relationship_Data_Document"
}
}
},
"UserEntitlements_Resource_Object": {
"required": ["id", "type"],
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/UserEntitlements_Attributes"
},
"id": {
"type": "string",
"description": "Resource id",
"example": "12345"
},
"relationships": {
"$ref": "#/components/schemas/UserEntitlements_Relationships"
},
"type": {
"minLength": 1,
"type": "string",
"description": "Resource type",
"example": "tracks"
}
}
},
"UserEntitlements_Single_Resource_Data_Document": {
"required": ["data", "links"],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/UserEntitlements_Resource_Object"
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"UserRecommendations_Attributes": {
"type": "object"
},
"UserRecommendations_Multi_Relationship_Data_Document": {
"required": ["links"],
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Resource_Identifier"
}
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"UserRecommendations_Multi_Resource_Data_Document": {
"required": ["data", "links"],
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserRecommendations_Resource_Object"
}
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"UserRecommendations_Relationships": {
"required": ["discoveryMixes", "myMixes", "newArrivalMixes"],
"properties": {
"discoveryMixes": {
"$ref": "#/components/schemas/Multi_Relationship_Data_Document"
},
"myMixes": {
"$ref": "#/components/schemas/Multi_Relationship_Data_Document"
},
"newArrivalMixes": {
"$ref": "#/components/schemas/Multi_Relationship_Data_Document"
}
}
},
"UserRecommendations_Resource_Object": {
"required": ["id", "type"],
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/UserRecommendations_Attributes"
},
"id": {
"type": "string",
"description": "Resource id",
"example": "12345"
},
"relationships": {
"$ref": "#/components/schemas/UserRecommendations_Relationships"
},
"type": {
"minLength": 1,
"type": "string",
"description": "Resource type",
"example": "tracks"
}
}
},
"UserRecommendations_Single_Resource_Data_Document": {
"required": ["data", "links"],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/UserRecommendations_Resource_Object"
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"UserReportCreateOperation_Payload": {
"required": ["data"],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/UserReportCreateOperation_Payload_Data"
}
}
},
"UserReportCreateOperation_Payload_Data": {
"required": ["attributes", "relationships", "type"],
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/UserReportCreateOperation_Payload_Data_Attributes"
},
"relationships": {
"$ref": "#/components/schemas/UserReportsCreateOperation_Payload_Data_Relationships"
},
"type": {
"type": "string",
"enum": ["userReports"]
}
}
},
"UserReportCreateOperation_Payload_Data_Attributes": {
"required": ["description", "reason"],
"type": "object",
"properties": {
"description": {
"type": "string"
},
"reason": {
"type": "string",
"enum": [
"SEXUAL_CONTENT_OR_NUDITY",
"VIOLENT_OR_DANGEROUS_CONTENT",
"HATEFUL_OR_ABUSIVE_CONTENT",
"HARASSMENT",
"PRIVACY_VIOLATION",
"SCAMS_OR_FRAUD",
"SPAM",
"COPYRIGHT_INFRINGEMENT",
"APPEAL",
"UNKNOWN"
]
}
}
},
"UserReportsCreateOperation_Payload_Data_Relationships": {
"required": ["reportedResources"],
"type": "object",
"properties": {
"reportedResources": {
"$ref": "#/components/schemas/UserReportsCreateOperation_Payload_Data_Relationships_ReportedResources"
}
}
},
"UserReportsCreateOperation_Payload_Data_Relationships_ReportedResources": {
"required": ["data"],
"type": "object",
"properties": {
"data": {
"maxItems": 1,
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/UserReportsCreateOperation_Payload_Data_Relationships_ReportedResources_Data"
}
}
}
},
"UserReportsCreateOperation_Payload_Data_Relationships_ReportedResources_Data": {
"required": ["id", "type"],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["tracks", "artists", "playlists"]
}
}
},
"UserReports_Attributes": {
"required": ["description", "reason"],
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "Description"
},
"reason": {
"type": "string",
"description": "Reason",
"enum": [
"SEXUAL_CONTENT_OR_NUDITY",
"VIOLENT_OR_DANGEROUS_CONTENT",
"HATEFUL_OR_ABUSIVE_CONTENT",
"HARASSMENT",
"PRIVACY_VIOLATION",
"SCAMS_OR_FRAUD",
"SPAM",
"COPYRIGHT_INFRINGEMENT",
"APPEAL",
"UNKNOWN"
]
}
}
},
"UserReports_Multi_Resource_Data_Document": {
"required": ["data", "links"],
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserReports_Resource_Object"
}
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"UserReports_Resource_Object": {
"required": ["id", "type"],
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/UserReports_Attributes"
},
"id": {
"type": "string",
"description": "Resource id",
"example": "12345"
},
"type": {
"minLength": 1,
"type": "string",
"description": "Resource type",
"example": "tracks"
}
}
},
"UserReports_Single_Resource_Data_Document": {
"required": ["data", "links"],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/UserReports_Resource_Object"
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"Users_Attributes": {
"required": ["country", "username"],
"type": "object",
"properties": {
"country": {
"type": "string",
"description": "ISO 3166-1 alpha-2 country code",
"example": "US"
},
"email": {
"type": "string",
"description": "email address",
"example": "test@test.com"
},
"emailVerified": {
"type": "boolean",
"description": "Is the email verified",
"example": true
},
"firstName": {
"type": "string",
"description": "Users first name",
"example": "John"
},
"lastName": {
"type": "string",
"description": "Users last name",
"example": "Rambo"
},
"nostrPublicKey": {
"type": "string",
"description": "Users nostr public key",
"example": "e3fc3965800f9c729b483a2a7291f30e569fbf5ab91a6eef332f9e28a5e923dd"
},
"username": {
"type": "string",
"description": "user name",
"example": "username"
}
}
},
"Users_Multi_Resource_Data_Document": {
"required": ["data", "links"],
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Users_Resource_Object"
}
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"Users_Resource_Object": {
"required": ["id", "type"],
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/Users_Attributes"
},
"id": {
"type": "string",
"description": "Resource id",
"example": "12345"
},
"type": {
"minLength": 1,
"type": "string",
"description": "Resource type",
"example": "tracks"
}
}
},
"Users_Single_Resource_Data_Document": {
"required": ["data", "links"],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Users_Resource_Object"
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"Videos_Attributes": {
"required": ["duration", "explicit", "isrc", "popularity", "title"],
"type": "object",
"properties": {
"availability": {
"type": "array",
"description": "Available usage for this video",
"items": {
"type": "string",
"enum": ["STREAM", "DJ", "STEM"]
}
},
"copyright": {
"$ref": "#/components/schemas/Copyright"
},
"duration": {
"type": "string",
"description": "Duration (ISO 8601)",
"example": "PT2M58S"
},
"explicit": {
"type": "boolean",
"description": "Explicit content",
"example": false
},
"externalLinks": {
"type": "array",
"description": "Video links external to TIDAL API",
"items": {
"$ref": "#/components/schemas/External_Link"
}
},
"isrc": {
"type": "string",
"description": "International Standard Recording Code (ISRC)",
"example": "TIDAL2274"
},
"popularity": {
"type": "number",
"description": "Popularity (0.0 - 1.0)",
"format": "double",
"example": 0.56
},
"releaseDate": {
"type": "string",
"description": "Release date (ISO-8601)",
"format": "date",
"example": "2017-06-27"
},
"title": {
"type": "string",
"description": "Video title",
"example": "Kill Jay Z"
},
"version": {
"type": "string",
"description": "Video version, complements title",
"example": "original, mix etc"
}
}
},
"Videos_Multi_Relationship_Data_Document": {
"required": ["links"],
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Resource_Identifier"
}
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"Videos_Multi_Resource_Data_Document": {
"required": ["data", "links"],
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Videos_Resource_Object"
}
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"Videos_Relationships": {
"required": [
"albums",
"artists",
"providers",
"replacement",
"thumbnailArt"
],
"properties": {
"albums": {
"$ref": "#/components/schemas/Multi_Relationship_Data_Document"
},
"artists": {
"$ref": "#/components/schemas/Multi_Relationship_Data_Document"
},
"providers": {
"$ref": "#/components/schemas/Multi_Relationship_Data_Document"
},
"replacement": {
"$ref": "#/components/schemas/Single_Relationship_Data_Document"
},
"thumbnailArt": {
"$ref": "#/components/schemas/Multi_Relationship_Data_Document"
}
}
},
"Videos_Resource_Object": {
"required": ["id", "type"],
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/Videos_Attributes"
},
"id": {
"type": "string",
"description": "Resource id",
"example": "12345"
},
"relationships": {
"$ref": "#/components/schemas/Videos_Relationships"
},
"type": {
"minLength": 1,
"type": "string",
"description": "Resource type",
"example": "tracks"
}
}
},
"Videos_Single_Relationship_Data_Document": {
"required": ["links"],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Resource_Identifier"
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
},
"Videos_Single_Resource_Data_Document": {
"required": ["data", "links"],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Videos_Resource_Object"
},
"included": {
"$ref": "#/components/schemas/Included"
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
}
},
"securitySchemes": {
"Authorization_Code_PKCE": {
"description": "See https://developer.tidal.com/documentation/authorization/authorization-authorization-code",
"flows": {
"authorizationCode": {
"authorizationUrl": "https://login.tidal.com/authorize",
"scopes": {
"collection.read": "Read access to a user's \"My Collection\".",
"collection.write": "Write access to a user's \"My Collection\".",
"entitlements.read": "Read access to what functionality a user is entitled to access on TIDAL, such as whether they can stream music, use DJ add-ons and similar.",
"playback": "Required to play media content and control playback.",
"playlists.read": "Required to list playlists created by a user.",
"playlists.write": "Write access to a user's playlists.",
"recommendations.read": "Read access to a user’s personal recommendations.",
"search.read": "Required to read personalized search results.",
"search.write": "Required to update personalized search results, e.g. delete search history.",
"user.read": "Read access to a user's account information, such as country and email address."
},
"tokenUrl": "https://auth.tidal.com/v1/oauth2/token",
"x-scopes-required-access-tier": {
"collection.read": "THIRD_PARTY",
"collection.write": "THIRD_PARTY",
"entitlements.read": "THIRD_PARTY",
"playback": "THIRD_PARTY",
"playlists.read": "THIRD_PARTY",
"playlists.write": "THIRD_PARTY",
"recommendations.read": "THIRD_PARTY",
"search.read": "THIRD_PARTY",
"search.write": "THIRD_PARTY",
"user.read": "THIRD_PARTY"
}
}
},
"type": "oauth2"
},
"Client_Credentials": {
"description": "See https://developer.tidal.com/documentation/authorization/authorization-client-credentials",
"flows": {
"clientCredentials": {
"scopes": {},
"tokenUrl": "https://auth.tidal.com/v1/oauth2/token"
}
},
"type": "oauth2"
}
}
}
}