openapi: 3.0.1 info: title: TIDAL User Collections API version: 1.10.14 description: 'My Collection: the user''s saved albums, artists, playlists, tracks, videos, folders, and save-for-later items.' x-source: https://tidal-music.github.io/tidal-api-reference/tidal-api-oas.json servers: - url: https://openapi.tidal.com/v2 description: Production paths: /userCollectionAlbums/{id}: get: description: Retrieves single userCollectionAlbum by id. parameters: - description: User collection albums id. Use `me` for the authenticated user's resource example: me 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: items, owners' example: items in: query name: include required: false schema: type: array items: type: string example: items responses: '200': content: application/vnd.api+json: schema: $ref: '#/components/schemas/UserCollectionAlbums_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 userCollectionAlbum. tags: - userCollectionAlbums x-path-item-properties: required-access-tier: THIRD_PARTY /userCollectionAlbums/{id}/relationships/items: delete: description: Deletes item(s) from items relationship. parameters: - description: User collection albums id. Use `me` for the authenticated user's resource example: me in: path name: id required: true schema: type: string - $ref: '#/components/parameters/IdempotencyKey' requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/UserCollectionAlbumsItemsRelationshipRemoveOperation_Payload' responses: '400': $ref: '#/components/responses/Default400Response' '404': $ref: '#/components/responses/Default404Response' '405': $ref: '#/components/responses/Default405Response' '406': $ref: '#/components/responses/Default406Response' '409': $ref: '#/components/responses/Idempotency409Response' '415': $ref: '#/components/responses/Default415Response' '422': $ref: '#/components/responses/Idempotency422Response' '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: - userCollectionAlbums x-path-item-properties: required-access-tier: THIRD_PARTY get: description: Retrieves items relationship. parameters: - description: User collection albums id. Use `me` for the authenticated user's resource example: me 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: addedAt enum: - addedAt - -addedAt - artists.name - -artists.name - releaseDate - -releaseDate - title - -title default: -addedAt x-enum-varnames: - AddedAtAsc - AddedAtDesc - ArtistsNameAsc - ArtistsNameDesc - ReleaseDateAsc - ReleaseDateDesc - TitleAsc - TitleDesc - 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: items' example: items in: query name: include required: false schema: type: array items: type: string example: items responses: '200': content: application/vnd.api+json: schema: $ref: '#/components/schemas/UserCollectionAlbums_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: - userCollectionAlbums x-path-item-properties: required-access-tier: THIRD_PARTY post: description: Adds item(s) to items relationship. parameters: - description: User collection albums id. Use `me` for the authenticated user's resource example: me 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 - $ref: '#/components/parameters/IdempotencyKey' requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/UserCollectionAlbumsItemsRelationshipAddOperation_Payload' responses: '200': content: application/vnd.api+json: schema: $ref: '#/components/schemas/UserCollectionAlbums_Items_Add_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' '409': $ref: '#/components/responses/UserCollectionAlbumsAddMultiDataRelationshipWithResponse409Response' '415': $ref: '#/components/responses/Default415Response' '422': $ref: '#/components/responses/Idempotency422Response' '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: - userCollectionAlbums x-path-item-properties: required-access-tier: THIRD_PARTY /userCollectionAlbums/{id}/relationships/owners: get: description: Retrieves owners relationship. parameters: - description: User collection albums id. Use `me` for the authenticated user's resource example: me 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/vnd.api+json: schema: $ref: '#/components/schemas/UserCollectionAlbums_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: - userCollectionAlbums x-path-item-properties: required-access-tier: THIRD_PARTY /userCollectionArtists/{id}: get: description: Retrieves single userCollectionArtist by id. parameters: - description: User collection artists id. Use `me` for the authenticated user's resource example: me 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: items, owners' example: items in: query name: include required: false schema: type: array items: type: string example: items responses: '200': content: application/vnd.api+json: schema: $ref: '#/components/schemas/UserCollectionArtists_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 userCollectionArtist. tags: - userCollectionArtists x-path-item-properties: required-access-tier: THIRD_PARTY /userCollectionArtists/{id}/relationships/items: delete: description: Deletes item(s) from items relationship. parameters: - description: User collection artists id. Use `me` for the authenticated user's resource example: me in: path name: id required: true schema: type: string - $ref: '#/components/parameters/IdempotencyKey' requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/UserCollectionArtistsItemsRelationshipRemoveOperation_Payload' responses: '400': $ref: '#/components/responses/Default400Response' '404': $ref: '#/components/responses/Default404Response' '405': $ref: '#/components/responses/Default405Response' '406': $ref: '#/components/responses/Default406Response' '409': $ref: '#/components/responses/Idempotency409Response' '415': $ref: '#/components/responses/Default415Response' '422': $ref: '#/components/responses/Idempotency422Response' '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: - userCollectionArtists x-path-item-properties: required-access-tier: THIRD_PARTY get: description: Retrieves items relationship. parameters: - description: User collection artists id. Use `me` for the authenticated user's resource example: me 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: addedAt enum: - addedAt - -addedAt - name - -name default: -addedAt x-enum-varnames: - AddedAtAsc - AddedAtDesc - NameAsc - NameDesc - 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: items' example: items in: query name: include required: false schema: type: array items: type: string example: items responses: '200': content: application/vnd.api+json: schema: $ref: '#/components/schemas/UserCollectionArtists_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: - userCollectionArtists x-path-item-properties: required-access-tier: THIRD_PARTY post: description: Adds item(s) to items relationship. parameters: - description: User collection artists id. Use `me` for the authenticated user's resource example: me 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 - $ref: '#/components/parameters/IdempotencyKey' requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/UserCollectionArtistsItemsRelationshipAddOperation_Payload' responses: '200': content: application/vnd.api+json: schema: $ref: '#/components/schemas/UserCollectionArtists_Items_Add_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' '409': $ref: '#/components/responses/UserCollectionArtistsAddMultiDataRelationshipWithResponse409Response' '415': $ref: '#/components/responses/Default415Response' '422': $ref: '#/components/responses/Idempotency422Response' '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: - userCollectionArtists x-path-item-properties: required-access-tier: THIRD_PARTY /userCollectionArtists/{id}/relationships/owners: get: description: Retrieves owners relationship. parameters: - description: User collection artists id. Use `me` for the authenticated user's resource example: me 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/vnd.api+json: schema: $ref: '#/components/schemas/UserCollectionArtists_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: - userCollectionArtists x-path-item-properties: required-access-tier: THIRD_PARTY /userCollectionFolders: get: 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 (e.g. `CBMHXUOuJZgroV2kWpeVLL1I7xdgvF6ocDEGCXov8SZq3WVhrOcOq5pjnGawKX`) in: query name: filter[id] required: false schema: type: array items: type: string responses: '200': content: application/vnd.api+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: description: Creates a new userCollectionFolder. parameters: - $ref: '#/components/parameters/IdempotencyKey' requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/UserCollectionFoldersCreateOperation_Payload' responses: '201': content: application/vnd.api+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' '409': $ref: '#/components/responses/Idempotency409Response' '415': $ref: '#/components/responses/Default415Response' '422': $ref: '#/components/responses/Idempotency422Response' '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: description: Deletes existing userCollectionFolder. parameters: - description: Folder Id example: CBMHXUOuJZgroV2kWpeVLL1I7xdgvF6ocDEGCXov8SZq3WVhrOcOq5pjnGawKX in: path name: id required: true schema: type: string - $ref: '#/components/parameters/IdempotencyKey' responses: '400': $ref: '#/components/responses/UserCollectionFoldersDeleteResource400Response' '404': $ref: '#/components/responses/Default404Response' '405': $ref: '#/components/responses/Default405Response' '406': $ref: '#/components/responses/Default406Response' '409': $ref: '#/components/responses/Idempotency409Response' '415': $ref: '#/components/responses/Default415Response' '422': $ref: '#/components/responses/Idempotency422Response' '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: description: Retrieves single userCollectionFolder by id. parameters: - description: Folder Id example: CBMHXUOuJZgroV2kWpeVLL1I7xdgvF6ocDEGCXov8SZq3WVhrOcOq5pjnGawKX 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/vnd.api+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: description: Updates existing userCollectionFolder. parameters: - description: Folder Id example: CBMHXUOuJZgroV2kWpeVLL1I7xdgvF6ocDEGCXov8SZq3WVhrOcOq5pjnGawKX in: path name: id required: true schema: type: string - $ref: '#/components/parameters/IdempotencyKey' requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/UserCollectionFoldersUpdateOperation_Payload' responses: '400': $ref: '#/components/responses/Default400Response' '404': $ref: '#/components/responses/Default404Response' '405': $ref: '#/components/responses/Default405Response' '406': $ref: '#/components/responses/Default406Response' '409': $ref: '#/components/responses/Idempotency409Response' '415': $ref: '#/components/responses/Default415Response' '422': $ref: '#/components/responses/Idempotency422Response' '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: description: Deletes item(s) from items relationship. parameters: - description: Folder Id example: CBMHXUOuJZgroV2kWpeVLL1I7xdgvF6ocDEGCXov8SZq3WVhrOcOq5pjnGawKX in: path name: id required: true schema: type: string - $ref: '#/components/parameters/IdempotencyKey' requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/UserCollectionFoldersItemsRelationshipRemoveOperation_Payload' responses: '400': $ref: '#/components/responses/Default400Response' '404': $ref: '#/components/responses/Default404Response' '405': $ref: '#/components/responses/Default405Response' '406': $ref: '#/components/responses/Default406Response' '409': $ref: '#/components/responses/Idempotency409Response' '415': $ref: '#/components/responses/Default415Response' '422': $ref: '#/components/responses/Idempotency422Response' '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: description: Retrieves items relationship. parameters: - description: Folder Id example: CBMHXUOuJZgroV2kWpeVLL1I7xdgvF6ocDEGCXov8SZq3WVhrOcOq5pjnGawKX 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: addedAt enum: - addedAt - -addedAt - lastModifiedAt - -lastModifiedAt - name - -name default: addedAt x-enum-varnames: - AddedAtAsc - AddedAtDesc - LastModifiedAtAsc - LastModifiedAtDesc - NameAsc - NameDesc - 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/vnd.api+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: description: Adds item(s) to items relationship. parameters: - description: Folder Id example: CBMHXUOuJZgroV2kWpeVLL1I7xdgvF6ocDEGCXov8SZq3WVhrOcOq5pjnGawKX in: path name: id required: true schema: type: string - $ref: '#/components/parameters/IdempotencyKey' requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/UserCollectionFoldersItemsRelationshipAddOperation_Payload' responses: '400': $ref: '#/components/responses/Default400Response' '404': $ref: '#/components/responses/Default404Response' '405': $ref: '#/components/responses/Default405Response' '406': $ref: '#/components/responses/Default406Response' '409': $ref: '#/components/responses/Idempotency409Response' '415': $ref: '#/components/responses/Default415Response' '422': $ref: '#/components/responses/Idempotency422Response' '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: description: Retrieves owners relationship. parameters: - description: Folder Id example: CBMHXUOuJZgroV2kWpeVLL1I7xdgvF6ocDEGCXov8SZq3WVhrOcOq5pjnGawKX 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/vnd.api+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 /userCollectionPlaylists/{id}: get: description: Retrieves single userCollectionPlaylist by id. parameters: - description: User collection playlists id. Use `me` for the authenticated user's resource example: me 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: items, owners' example: items in: query name: include required: false schema: type: array items: type: string example: items responses: '200': content: application/vnd.api+json: schema: $ref: '#/components/schemas/UserCollectionPlaylists_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 userCollectionPlaylist. tags: - userCollectionPlaylists x-path-item-properties: required-access-tier: THIRD_PARTY /userCollectionPlaylists/{id}/relationships/items: delete: description: Deletes item(s) from items relationship. parameters: - description: User collection playlists id. Use `me` for the authenticated user's resource example: me in: path name: id required: true schema: type: string - $ref: '#/components/parameters/IdempotencyKey' requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/UserCollectionPlaylistsItemsRelationshipRemoveOperation_Payload' responses: '400': $ref: '#/components/responses/Default400Response' '404': $ref: '#/components/responses/Default404Response' '405': $ref: '#/components/responses/Default405Response' '406': $ref: '#/components/responses/Default406Response' '409': $ref: '#/components/responses/Idempotency409Response' '415': $ref: '#/components/responses/Default415Response' '422': $ref: '#/components/responses/Idempotency422Response' '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: - userCollectionPlaylists x-path-item-properties: required-access-tier: THIRD_PARTY get: description: Retrieves items relationship. parameters: - description: User collection playlists id. Use `me` for the authenticated user's resource example: me 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: addedAt enum: - addedAt - -addedAt - lastModifiedAt - -lastModifiedAt - name - -name default: -addedAt x-enum-varnames: - AddedAtAsc - AddedAtDesc - LastModifiedAtAsc - LastModifiedAtDesc - NameAsc - NameDesc - 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/vnd.api+json: schema: $ref: '#/components/schemas/UserCollectionPlaylists_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: - userCollectionPlaylists x-path-item-properties: required-access-tier: THIRD_PARTY post: description: Adds item(s) to items relationship. parameters: - description: User collection playlists id. Use `me` for the authenticated user's resource example: me in: path name: id required: true schema: type: string - $ref: '#/components/parameters/IdempotencyKey' requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/UserCollectionPlaylistsItemsRelationshipAddOperation_Payload' responses: '200': content: application/vnd.api+json: schema: $ref: '#/components/schemas/UserCollectionPlaylists_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' '409': $ref: '#/components/responses/UserCollectionPlaylistsAddMultiDataRelationshipWithResponse409Response' '415': $ref: '#/components/responses/Default415Response' '422': $ref: '#/components/responses/Idempotency422Response' '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: - userCollectionPlaylists x-path-item-properties: required-access-tier: THIRD_PARTY /userCollectionPlaylists/{id}/relationships/owners: get: description: Retrieves owners relationship. parameters: - description: User collection playlists id. Use `me` for the authenticated user's resource example: me 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/vnd.api+json: schema: $ref: '#/components/schemas/UserCollectionPlaylists_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: - userCollectionPlaylists x-path-item-properties: required-access-tier: THIRD_PARTY /userCollectionSaveForLaters/{id}: get: description: Retrieves single userCollectionSaveForLater by id. parameters: - description: User collection save for later id. Use `me` for the authenticated user's resource example: me 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/vnd.api+json: schema: $ref: '#/components/schemas/UserCollectionSaveForLaters_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 userCollectionSaveForLater. tags: - userCollectionSaveForLaters x-path-item-properties: required-access-tier: INTERNAL /userCollectionSaveForLaters/{id}/relationships/items: delete: description: Deletes item(s) from items relationship. parameters: - description: User collection save for later id. Use `me` for the authenticated user's resource example: me in: path name: id required: true schema: type: string - $ref: '#/components/parameters/IdempotencyKey' requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/UserCollectionSaveForLatersItemsRelationshipRemoveOperation_Payload' responses: '400': $ref: '#/components/responses/Default400Response' '404': $ref: '#/components/responses/Default404Response' '405': $ref: '#/components/responses/Default405Response' '406': $ref: '#/components/responses/Default406Response' '409': $ref: '#/components/responses/Idempotency409Response' '415': $ref: '#/components/responses/Default415Response' '422': $ref: '#/components/responses/Idempotency422Response' '429': $ref: '#/components/responses/Default429Response' '500': $ref: '#/components/responses/Default500Response' '503': $ref: '#/components/responses/Default503Response' security: - Authorization_Code_PKCE: - w_usr summary: Delete from items relationship ("to-many"). tags: - userCollectionSaveForLaters x-path-item-properties: required-access-tier: INTERNAL get: description: Retrieves items relationship. parameters: - description: User collection save for later id. Use `me` for the authenticated user's resource example: me 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/vnd.api+json: schema: $ref: '#/components/schemas/UserCollectionSaveForLaters_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: - r_usr summary: Get items relationship ("to-many"). tags: - userCollectionSaveForLaters x-path-item-properties: required-access-tier: INTERNAL post: description: Adds item(s) to items relationship. parameters: - description: User collection save for later id. Use `me` for the authenticated user's resource example: me 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 - $ref: '#/components/parameters/IdempotencyKey' requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/UserCollectionSaveForLatersItemsRelationshipAddOperation_Payload' responses: '200': content: application/vnd.api+json: schema: $ref: '#/components/schemas/UserCollectionSaveForLaters_Items_Add_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' '409': $ref: '#/components/responses/UserCollectionSaveForLatersAddMultiDataRelationshipWithResponse409Response' '415': $ref: '#/components/responses/Default415Response' '422': $ref: '#/components/responses/Idempotency422Response' '429': $ref: '#/components/responses/Default429Response' '500': $ref: '#/components/responses/Default500Response' '503': $ref: '#/components/responses/Default503Response' security: - Authorization_Code_PKCE: - w_usr summary: Add to items relationship ("to-many"). tags: - userCollectionSaveForLaters x-path-item-properties: required-access-tier: INTERNAL /userCollectionSaveForLaters/{id}/relationships/owners: get: description: Retrieves owners relationship. parameters: - description: User collection save for later id. Use `me` for the authenticated user's resource example: me 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/vnd.api+json: schema: $ref: '#/components/schemas/UserCollectionSaveForLaters_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: - userCollectionSaveForLaters x-path-item-properties: required-access-tier: INTERNAL /userCollectionTracks: get: description: Retrieves multiple userCollectionTracks 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: 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: items, owners' example: items in: query name: include required: false schema: type: array items: type: string example: items - description: User collection tracks id (e.g. `FMJUCzH4`) in: query name: filter[id] required: false schema: type: array items: type: string responses: '200': content: application/vnd.api+json: schema: $ref: '#/components/schemas/UserCollectionTracks_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 userCollectionTracks. tags: - userCollectionTracks x-path-item-properties: required-access-tier: THIRD_PARTY /userCollectionTracks/{id}: get: description: Retrieves single userCollectionTrack by id. parameters: - description: User collection tracks id. Use `me` for the authenticated user's resource example: me 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: items, owners' example: items in: query name: include required: false schema: type: array items: type: string example: items responses: '200': content: application/vnd.api+json: schema: $ref: '#/components/schemas/UserCollectionTracks_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 userCollectionTrack. tags: - userCollectionTracks x-path-item-properties: required-access-tier: THIRD_PARTY /userCollectionTracks/{id}/relationships/items: delete: description: Deletes item(s) from items relationship. parameters: - description: User collection tracks id. Use `me` for the authenticated user's resource example: me in: path name: id required: true schema: type: string - $ref: '#/components/parameters/IdempotencyKey' requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/UserCollectionTracksItemsRelationshipRemoveOperation_Payload' responses: '400': $ref: '#/components/responses/Default400Response' '404': $ref: '#/components/responses/Default404Response' '405': $ref: '#/components/responses/Default405Response' '406': $ref: '#/components/responses/Default406Response' '409': $ref: '#/components/responses/Idempotency409Response' '415': $ref: '#/components/responses/Default415Response' '422': $ref: '#/components/responses/Idempotency422Response' '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: - userCollectionTracks x-path-item-properties: required-access-tier: THIRD_PARTY get: description: Retrieves items relationship. parameters: - description: User collection tracks id. Use `me` for the authenticated user's resource example: me 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: addedAt enum: - addedAt - -addedAt - albums.title - -albums.title - artists.name - -artists.name - duration - -duration - title - -title default: -addedAt x-enum-varnames: - AddedAtAsc - AddedAtDesc - AlbumsTitleAsc - AlbumsTitleDesc - ArtistsNameAsc - ArtistsNameDesc - DurationAsc - DurationDesc - TitleAsc - TitleDesc - 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: items' example: items in: query name: include required: false schema: type: array items: type: string example: items responses: '200': content: application/vnd.api+json: schema: $ref: '#/components/schemas/UserCollectionTracks_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: - userCollectionTracks x-path-item-properties: required-access-tier: THIRD_PARTY post: description: Adds item(s) to items relationship. parameters: - description: User collection tracks id. Use `me` for the authenticated user's resource example: me 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 - $ref: '#/components/parameters/IdempotencyKey' requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/UserCollectionTracksItemsRelationshipAddOperation_Payload' responses: '200': content: application/vnd.api+json: schema: $ref: '#/components/schemas/UserCollectionTracks_Items_Add_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' '409': $ref: '#/components/responses/UserCollectionTracksAddMultiDataRelationshipWithResponse409Response' '415': $ref: '#/components/responses/Default415Response' '422': $ref: '#/components/responses/Idempotency422Response' '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: - userCollectionTracks x-path-item-properties: required-access-tier: THIRD_PARTY /userCollectionTracks/{id}/relationships/owners: get: description: Retrieves owners relationship. parameters: - description: User collection tracks id. Use `me` for the authenticated user's resource example: me 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/vnd.api+json: schema: $ref: '#/components/schemas/UserCollectionTracks_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: - userCollectionTracks x-path-item-properties: required-access-tier: THIRD_PARTY /userCollectionVideos/{id}: get: description: Retrieves single userCollectionVideo by id. parameters: - description: User collection videos id. Use `me` for the authenticated user's resource example: me 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: items, owners' example: items in: query name: include required: false schema: type: array items: type: string example: items responses: '200': content: application/vnd.api+json: schema: $ref: '#/components/schemas/UserCollectionVideos_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 userCollectionVideo. tags: - userCollectionVideos x-path-item-properties: required-access-tier: THIRD_PARTY /userCollectionVideos/{id}/relationships/items: delete: description: Deletes item(s) from items relationship. parameters: - description: User collection videos id. Use `me` for the authenticated user's resource example: me in: path name: id required: true schema: type: string - $ref: '#/components/parameters/IdempotencyKey' requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/UserCollectionVideosItemsRelationshipRemoveOperation_Payload' responses: '400': $ref: '#/components/responses/Default400Response' '404': $ref: '#/components/responses/Default404Response' '405': $ref: '#/components/responses/Default405Response' '406': $ref: '#/components/responses/Default406Response' '409': $ref: '#/components/responses/Idempotency409Response' '415': $ref: '#/components/responses/Default415Response' '422': $ref: '#/components/responses/Idempotency422Response' '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: - userCollectionVideos x-path-item-properties: required-access-tier: THIRD_PARTY get: description: Retrieves items relationship. parameters: - description: User collection videos id. Use `me` for the authenticated user's resource example: me 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: addedAt enum: - addedAt - -addedAt - artists.name - -artists.name - duration - -duration - title - -title default: -addedAt x-enum-varnames: - AddedAtAsc - AddedAtDesc - ArtistsNameAsc - ArtistsNameDesc - DurationAsc - DurationDesc - TitleAsc - TitleDesc - 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: items' example: items in: query name: include required: false schema: type: array items: type: string example: items responses: '200': content: application/vnd.api+json: schema: $ref: '#/components/schemas/UserCollectionVideos_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: - userCollectionVideos x-path-item-properties: required-access-tier: THIRD_PARTY post: description: Adds item(s) to items relationship. parameters: - description: User collection videos id. Use `me` for the authenticated user's resource example: me 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 - $ref: '#/components/parameters/IdempotencyKey' requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/UserCollectionVideosItemsRelationshipAddOperation_Payload' responses: '200': content: application/vnd.api+json: schema: $ref: '#/components/schemas/UserCollectionVideos_Items_Add_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' '409': $ref: '#/components/responses/UserCollectionVideosAddMultiDataRelationshipWithResponse409Response' '415': $ref: '#/components/responses/Default415Response' '422': $ref: '#/components/responses/Idempotency422Response' '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: - userCollectionVideos x-path-item-properties: required-access-tier: THIRD_PARTY /userCollectionVideos/{id}/relationships/owners: get: description: Retrieves owners relationship. parameters: - description: User collection videos id. Use `me` for the authenticated user's resource example: me 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/vnd.api+json: schema: $ref: '#/components/schemas/UserCollectionVideos_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: - userCollectionVideos x-path-item-properties: required-access-tier: THIRD_PARTY /userCollections/{id}: get: deprecated: true description: 'Deprecated. Use the dedicated collection resources instead: userCollectionAlbums, userCollectionArtists, userCollectionTracks, userCollectionVideos, or userCollectionPlaylists.' 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/vnd.api+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: deprecated: true description: Deprecated. Use the userCollectionAlbums resource and its items relationship instead. parameters: - description: User collection id example: '123456' in: path name: id required: true schema: type: string - $ref: '#/components/parameters/IdempotencyKey' requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/UserCollectionsAlbumsRelationshipRemoveOperation_Payload' responses: '400': $ref: '#/components/responses/Default400Response' '404': $ref: '#/components/responses/Default404Response' '405': $ref: '#/components/responses/Default405Response' '406': $ref: '#/components/responses/Default406Response' '409': $ref: '#/components/responses/Idempotency409Response' '415': $ref: '#/components/responses/Default415Response' '422': $ref: '#/components/responses/Idempotency422Response' '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: deprecated: true description: Deprecated. Use the userCollectionAlbums resource and its items relationship instead. 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/vnd.api+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: deprecated: true description: Deprecated. Use the userCollectionAlbums resource and its items relationship instead. 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 - $ref: '#/components/parameters/IdempotencyKey' requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/UserCollectionsAlbumsRelationshipAddOperation_Payload' responses: '400': $ref: '#/components/responses/Default400Response' '404': $ref: '#/components/responses/Default404Response' '405': $ref: '#/components/responses/Default405Response' '406': $ref: '#/components/responses/Default406Response' '409': $ref: '#/components/responses/UserCollectionsAddMultiDataRelationship409Response' '415': $ref: '#/components/responses/Default415Response' '422': $ref: '#/components/responses/Idempotency422Response' '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: deprecated: true description: Deprecated. Use the userCollectionArtists resource and its items relationship instead. parameters: - description: User collection id example: '123456' in: path name: id required: true schema: type: string - $ref: '#/components/parameters/IdempotencyKey' requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/UserCollectionsArtistsRelationshipRemoveOperation_Payload' responses: '400': $ref: '#/components/responses/Default400Response' '404': $ref: '#/components/responses/Default404Response' '405': $ref: '#/components/responses/Default405Response' '406': $ref: '#/components/responses/Default406Response' '409': $ref: '#/components/responses/Idempotency409Response' '415': $ref: '#/components/responses/Default415Response' '422': $ref: '#/components/responses/Idempotency422Response' '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: deprecated: true description: Deprecated. Use the userCollectionArtists resource and its items relationship instead. 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/vnd.api+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: deprecated: true description: Deprecated. Use the userCollectionArtists resource and its items relationship instead. 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 - $ref: '#/components/parameters/IdempotencyKey' requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/UserCollectionsArtistsRelationshipAddOperation_Payload' responses: '400': $ref: '#/components/responses/Default400Response' '404': $ref: '#/components/responses/Default404Response' '405': $ref: '#/components/responses/Default405Response' '406': $ref: '#/components/responses/Default406Response' '409': $ref: '#/components/responses/UserCollectionsAddMultiDataRelationship409Response' '415': $ref: '#/components/responses/Default415Response' '422': $ref: '#/components/responses/Idempotency422Response' '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: 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/vnd.api+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: deprecated: true description: Deprecated. Use the userCollectionPlaylists resource and its items relationship instead. parameters: - description: User collection id example: '123456' in: path name: id required: true schema: type: string - $ref: '#/components/parameters/IdempotencyKey' requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/UserCollectionsPlaylistsRelationshipRemoveOperation_Payload' responses: '400': $ref: '#/components/responses/Default400Response' '404': $ref: '#/components/responses/Default404Response' '405': $ref: '#/components/responses/Default405Response' '406': $ref: '#/components/responses/Default406Response' '409': $ref: '#/components/responses/Idempotency409Response' '415': $ref: '#/components/responses/Default415Response' '422': $ref: '#/components/responses/Idempotency422Response' '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: deprecated: true description: Deprecated. Use the userCollectionPlaylists resource and its items relationship instead. 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/vnd.api+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: deprecated: true description: Deprecated. Use the userCollectionPlaylists resource and its items relationship instead. parameters: - description: User collection id example: '123456' in: path name: id required: true schema: type: string - $ref: '#/components/parameters/IdempotencyKey' requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/UserCollectionsPlaylistsRelationshipAddOperation_Payload' responses: '400': $ref: '#/components/responses/Default400Response' '404': $ref: '#/components/responses/Default404Response' '405': $ref: '#/components/responses/Default405Response' '406': $ref: '#/components/responses/Default406Response' '409': $ref: '#/components/responses/UserCollectionsAddMultiDataRelationship409Response' '415': $ref: '#/components/responses/Default415Response' '422': $ref: '#/components/responses/Idempotency422Response' '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: deprecated: true description: Deprecated. Use the userCollectionTracks resource and its items relationship instead. parameters: - description: User collection id example: '123456' in: path name: id required: true schema: type: string - $ref: '#/components/parameters/IdempotencyKey' requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/UserCollectionsTracksRelationshipRemoveOperation_Payload' responses: '400': $ref: '#/components/responses/Default400Response' '404': $ref: '#/components/responses/Default404Response' '405': $ref: '#/components/responses/Default405Response' '406': $ref: '#/components/responses/Default406Response' '409': $ref: '#/components/responses/Idempotency409Response' '415': $ref: '#/components/responses/Default415Response' '422': $ref: '#/components/responses/Idempotency422Response' '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: deprecated: true description: Deprecated. Use the userCollectionTracks resource and its items relationship instead. 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/vnd.api+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: deprecated: true description: Deprecated. Use the userCollectionTracks resource and its items relationship instead. 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 - $ref: '#/components/parameters/IdempotencyKey' requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/UserCollectionsTracksRelationshipAddOperation_Payload' responses: '400': $ref: '#/components/responses/Default400Response' '404': $ref: '#/components/responses/Default404Response' '405': $ref: '#/components/responses/Default405Response' '406': $ref: '#/components/responses/Default406Response' '409': $ref: '#/components/responses/UserCollectionsAddMultiDataRelationship409Response' '415': $ref: '#/components/responses/Default415Response' '422': $ref: '#/components/responses/Idempotency422Response' '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: deprecated: true description: Deprecated. Use the userCollectionVideos resource and its items relationship instead. parameters: - description: User collection id example: '123456' in: path name: id required: true schema: type: string - $ref: '#/components/parameters/IdempotencyKey' requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/UserCollectionsVideosRelationshipRemoveOperation_Payload' responses: '400': $ref: '#/components/responses/Default400Response' '404': $ref: '#/components/responses/Default404Response' '405': $ref: '#/components/responses/Default405Response' '406': $ref: '#/components/responses/Default406Response' '409': $ref: '#/components/responses/Idempotency409Response' '415': $ref: '#/components/responses/Default415Response' '422': $ref: '#/components/responses/Idempotency422Response' '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: deprecated: true description: Deprecated. Use the userCollectionVideos resource and its items relationship instead. 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/vnd.api+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: deprecated: true description: Deprecated. Use the userCollectionVideos resource and its items relationship instead. 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 - $ref: '#/components/parameters/IdempotencyKey' requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/UserCollectionsVideosRelationshipAddOperation_Payload' responses: '400': $ref: '#/components/responses/Default400Response' '404': $ref: '#/components/responses/Default404Response' '405': $ref: '#/components/responses/Default405Response' '406': $ref: '#/components/responses/Default406Response' '409': $ref: '#/components/responses/UserCollectionsAddMultiDataRelationship409Response' '415': $ref: '#/components/responses/Default415Response' '422': $ref: '#/components/responses/Idempotency422Response' '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 components: schemas: 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' 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 - SUSPENDED VideoManifests_Attributes: type: object properties: drmData: $ref: '#/components/schemas/DrmData' link: $ref: '#/components/schemas/Link_Object' previewReason: type: string description: Why a preview is served instead of the full video enum: - FULL_REQUIRES_SUBSCRIPTION - FULL_REQUIRES_PURCHASE - FULL_REQUIRES_HIGHER_ACCESS_TIER videoPresentation: type: string description: Video presentation enum: - FULL - PREVIEW UserOfflineMixes_Attributes: type: object UserCollections_Playlists_Resource_Identifier_Meta: required: - addedAt type: object properties: addedAt: type: string format: date-time 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 DrmData: type: object properties: certificateUrl: type: string drmSystem: type: string enum: - FAIRPLAY - WIDEVINE initData: type: array items: type: string licenseUrl: type: string description: DRM data. Absence implies no DRM. UserCollectionSaveForLatersItemsRelationshipAddOperation_Payload_Data: required: - id - type type: object properties: id: type: string type: type: string enum: - tracks - albums - artists - playlists - videos UserCollections_Attributes: type: object 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' Shares_Relationships: properties: owners: $ref: '#/components/schemas/Multi_Relationship_Data_Document' sharedResources: $ref: '#/components/schemas/Multi_Relationship_Data_Document' Videos_Relationships: properties: albums: $ref: '#/components/schemas/Multi_Relationship_Data_Document' artists: $ref: '#/components/schemas/Multi_Relationship_Data_Document' credits: $ref: '#/components/schemas/Multi_Relationship_Data_Document' providers: $ref: '#/components/schemas/Multi_Relationship_Data_Document' replacement: $ref: '#/components/schemas/Single_Relationship_Data_Document' similarVideos: $ref: '#/components/schemas/Multi_Relationship_Data_Document' suggestedVideos: $ref: '#/components/schemas/Multi_Relationship_Data_Document' thumbnailArt: $ref: '#/components/schemas/Multi_Relationship_Data_Document' usageRules: $ref: '#/components/schemas/Single_Relationship_Data_Document' ProviderProductInfos_Relationships: properties: provider: $ref: '#/components/schemas/Single_Relationship_Data_Document' subject: $ref: '#/components/schemas/Single_Relationship_Data_Document' UserCollectionFoldersUpdateOperation_Payload_Data_Attributes: type: object properties: name: type: string Installations_OfflineInventory_Multi_Relationship_Data_Document: required: - links type: object properties: data: type: array items: $ref: '#/components/schemas/Installations_OfflineInventory_Resource_Identifier' included: $ref: '#/components/schemas/Included' links: $ref: '#/components/schemas/Links' UserDataExportRequests_Attributes: required: - flowType type: object properties: flowType: type: string description: The type of data export flow enum: - GDPR - CCPA - COPPA - ANZ_PA - US_PRIVACY_REGULATION - APPI - RETENTION_POLICY Purchases_Relationships: properties: owners: $ref: '#/components/schemas/Multi_Relationship_Data_Document' subject: $ref: '#/components/schemas/Single_Relationship_Data_Document' UserCollectionsArtistsRelationshipAddOperation_Payload_Data_Meta: type: object properties: addedAt: type: string format: date-time Clients_Resource_Object: required: - id - type type: object properties: attributes: $ref: '#/components/schemas/Clients_Attributes' id: type: string description: Resource id example: '12345' relationships: $ref: '#/components/schemas/Clients_Relationships' type: minLength: 1 type: string description: Resource type example: tracks Multi_Relationship_Data_Document: required: - links type: object properties: data: type: array items: $ref: '#/components/schemas/Resource_Identifier' 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 UserCollectionPlaylists_Relationships: properties: items: $ref: '#/components/schemas/UserCollectionPlaylists_Items_Multi_Relationship_Data_Document' owners: $ref: '#/components/schemas/Multi_Relationship_Data_Document' UserOfflineMixes_Resource_Object: required: - id - type type: object properties: attributes: $ref: '#/components/schemas/UserOfflineMixes_Attributes' id: type: string description: Resource id example: '12345' relationships: $ref: '#/components/schemas/UserOfflineMixes_Relationships' type: minLength: 1 type: string description: Resource type example: tracks UserCollectionArtistsItemsRelationshipRemoveOperation_Payload: required: - data type: object properties: data: maxItems: 20 minItems: 1 type: array items: $ref: '#/components/schemas/UserCollectionArtistsItemsRelationshipRemoveOperation_Payload_Data' UserCollectionsPlaylistsRelationshipRemoveOperation_Payload: required: - data type: object properties: data: maxItems: 20 minItems: 1 type: array items: $ref: '#/components/schemas/UserCollectionsPlaylistsRelationshipRemoveOperation_Payload_Data' 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 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 UserCollectionsPlaylistsRelationshipAddOperation_Payload_Data: required: - id - type type: object properties: id: type: string type: type: string enum: - playlists 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 - DELETED description: File status StripeDashboardLinks_Resource_Object: required: - id - type type: object properties: attributes: $ref: '#/components/schemas/StripeDashboardLinks_Attributes' id: type: string description: Resource id example: '12345' relationships: $ref: '#/components/schemas/StripeDashboardLinks_Relationships' type: minLength: 1 type: string description: Resource type example: tracks UserCollections_Relationships: 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' UserCollectionSaveForLatersItemsRelationshipRemoveOperation_Payload_Data: required: - id - type type: object properties: id: type: string type: type: string enum: - tracks - albums - artists - playlists - videos UserCollectionFoldersCreateOperation_Payload_Data_Attributes: required: - collectionType - name type: object properties: collectionType: type: string enum: - PLAYLISTS name: type: string UserCollectionFoldersItemsRelationshipAddOperation_Payload: type: object properties: data: maxItems: 10 minItems: 1 type: array items: $ref: '#/components/schemas/UserCollectionFoldersItemsRelationshipAddOperation_Payload_Data' UserNewReleaseMixes_Resource_Object: required: - id - type type: object properties: attributes: $ref: '#/components/schemas/UserNewReleaseMixes_Attributes' id: type: string description: Resource id example: '12345' relationships: $ref: '#/components/schemas/UserNewReleaseMixes_Relationships' type: minLength: 1 type: string description: Resource type example: tracks DspSharingLinks_Relationships: properties: subject: $ref: '#/components/schemas/Single_Relationship_Data_Document' Purchases_Attributes: required: - createdAt - status type: object properties: createdAt: type: string description: Datetime of purchase (ISO 8601) format: date-time status: type: string description: Current status of the purchase enum: - ACTIVE 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 AcceptedTerms_Attributes: required: - createdAt type: object properties: createdAt: type: string format: date-time UserCollectionsTracksRelationshipAddOperation_Payload_Data_Meta: type: object properties: addedAt: type: string format: date-time SavedShares_Attributes: required: - createdAt type: object properties: createdAt: type: string description: Datetime of saved share creation (ISO 8601) format: date-time Credits_Resource_Object: required: - id - type type: object properties: attributes: $ref: '#/components/schemas/Credits_Attributes' id: type: string description: Resource id example: '12345' relationships: $ref: '#/components/schemas/Credits_Relationships' type: minLength: 1 type: string description: Resource type example: tracks Artists_Following_Resource_Identifier_Meta: type: object properties: viewer: $ref: '#/components/schemas/Artists_Followers_Resource_Meta_ViewerContext' Credits_Attributes: required: - name - role type: object properties: name: type: string description: Credit name example: John Lennon role: type: string description: Credit role example: Vocals StripeDashboardLinks_Relationships: properties: owners: $ref: '#/components/schemas/Multi_Relationship_Data_Document' 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_UPLOADS - HOME_EDITORIAL - HOME_FREE - ARTIST reportingId: type: string description: Id used for reporting user events format: uuid example: 83c92ac0-b8e3-4e28-9e27-07909dcde1e5 ContentClaims_Resource_Object: required: - id - type type: object properties: attributes: $ref: '#/components/schemas/ContentClaims_Attributes' id: type: string description: Resource id example: '12345' relationships: $ref: '#/components/schemas/ContentClaims_Relationships' type: minLength: 1 type: string description: Resource type example: tracks 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' UserCollectionSaveForLatersItemsRelationshipAddOperation_Response_Meta_SkippedItem: required: - id - reason - type type: object properties: id: type: string reason: type: string enum: - NOT_FOUND - ALREADY_PRESENT type: type: string enum: - tracks - albums - artists - playlists - videos UserCollectionAlbums_Items_Multi_Relationship_Data_Document: required: - links type: object properties: data: type: array items: $ref: '#/components/schemas/UserCollectionAlbums_Items_Resource_Identifier' included: $ref: '#/components/schemas/Included' links: $ref: '#/components/schemas/Links' ArtistRoles_Attributes: required: - name type: object properties: name: type: string description: Name of the artist role SearchSuggestions_Highlights: required: - length - start type: object properties: length: type: integer format: int32 start: type: integer format: int32 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 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 UserCollectionArtistsItemsRelationshipAddOperation_Payload: required: - data type: object properties: data: maxItems: 20 minItems: 1 type: array items: $ref: '#/components/schemas/UserCollectionArtistsItemsRelationshipAddOperation_Payload_Data' 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 Copyright: required: - text type: object properties: text: maxLength: 1024 minLength: 1 type: string description: Copyright information Download_Link_Meta: type: object properties: requiredHeaders: type: array description: HTTP headers required when requesting the download URL items: type: string description: HTTP headers required when requesting the download URL description: Metadata for download link 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' UserCollections_Artists_Resource_Identifier_Meta: required: - addedAt type: object properties: addedAt: type: string format: date-time UserCollectionSaveForLaters_Items_Add_Multi_Relationship_Data_Document: required: - links type: object properties: data: type: array items: $ref: '#/components/schemas/UserCollectionSaveForLaters_Items_Resource_Identifier' included: $ref: '#/components/schemas/Included' links: $ref: '#/components/schemas/Links' meta: $ref: '#/components/schemas/UserCollectionSaveForLaters_Items_Add_Multi_Relationship_Data_Document_Meta' 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 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 UserCollectionArtists_Items_Add_Multi_Relationship_Data_Document: required: - links type: object properties: data: type: array items: $ref: '#/components/schemas/UserCollectionArtists_Items_Resource_Identifier' included: $ref: '#/components/schemas/Included' links: $ref: '#/components/schemas/Links' meta: $ref: '#/components/schemas/UserCollectionArtists_Items_Add_Multi_Relationship_Data_Document_Meta' 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 UserDiscoveryMixes_Relationships: properties: items: $ref: '#/components/schemas/Multi_Relationship_Data_Document' 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' UserCollectionFoldersUpdateOperation_Payload_Data: required: - attributes - id - type type: object properties: attributes: $ref: '#/components/schemas/UserCollectionFoldersUpdateOperation_Payload_Data_Attributes' id: type: string type: type: string enum: - userCollectionFolders SquareConnections_Resource_Object: required: - id - type type: object properties: attributes: $ref: '#/components/schemas/SquareConnections_Attributes' id: type: string description: Resource id example: '12345' type: minLength: 1 type: string description: Resource type example: tracks 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' SquareConnections_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 Square 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 Square connection enum: - DRAFT - PENDING_REQUIREMENTS - KYC_PENDING - ACCEPTED - REJECTED - SUSPENDED UserCollectionTracks_Resource_Object: required: - id - type type: object properties: attributes: $ref: '#/components/schemas/UserCollectionTracks_Attributes' id: type: string description: Resource id example: '12345' relationships: $ref: '#/components/schemas/UserCollectionTracks_Relationships' type: minLength: 1 type: string description: Resource type example: tracks 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 UserCollectionArtists_Resource_Object: required: - id - type type: object properties: attributes: $ref: '#/components/schemas/UserCollectionArtists_Attributes' id: type: string description: Resource id example: '12345' relationships: $ref: '#/components/schemas/UserCollectionArtists_Relationships' type: minLength: 1 type: string description: Resource type example: tracks 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' 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 UserCollectionAlbums_Attributes: required: - numberOfItems type: object properties: lastModifiedAt: type: string description: When the collection was last modified format: date-time numberOfItems: type: integer description: Number of items in the collection format: int32 SearchSuggestions_Relationships: properties: directHits: $ref: '#/components/schemas/Multi_Relationship_Data_Document' history: $ref: '#/components/schemas/Multi_Relationship_Data_Document' UserCollectionVideos_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' DynamicModules_Relationships: properties: items: $ref: '#/components/schemas/Multi_Relationship_Data_Document' TrackStatistics_Relationships: properties: owners: $ref: '#/components/schemas/Multi_Relationship_Data_Document' UserCollectionsArtistsRelationshipRemoveOperation_Payload: required: - data type: object properties: data: maxItems: 20 minItems: 1 type: array items: $ref: '#/components/schemas/UserCollectionsArtistsRelationshipRemoveOperation_Payload_Data' UserCollectionSaveForLatersItemsRelationshipAddOperation_Payload: required: - data type: object properties: data: maxItems: 20 minItems: 1 type: array items: $ref: '#/components/schemas/UserCollectionSaveForLatersItemsRelationshipAddOperation_Payload_Data' 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 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 TracksMetadataStatus_Resource_Object: required: - id - type type: object properties: attributes: $ref: '#/components/schemas/TracksMetadataStatus_Attributes' id: type: string description: Resource id example: '12345' type: minLength: 1 type: string description: Resource type example: tracks ProviderOwners_Relationships: properties: owners: $ref: '#/components/schemas/Multi_Relationship_Data_Document' provider: $ref: '#/components/schemas/Single_Relationship_Data_Document' UserNewReleaseMixes_Attributes: type: object UserCollectionPlaylistsItemsRelationshipRemoveOperation_Payload_Data: required: - id - type type: object properties: id: type: string type: type: string enum: - playlists 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 UserCollectionPlaylistsItemsRelationshipAddOperation_Payload_Data: required: - id - type type: object properties: id: type: string type: type: string enum: - playlists 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' Credits_Relationships: properties: artist: $ref: '#/components/schemas/Single_Relationship_Data_Document' category: $ref: '#/components/schemas/Single_Relationship_Data_Document' UserCollectionVideos_Items_Resource_Identifier_Meta: required: - addedAt type: object properties: addedAt: type: string format: date-time UserCollectionArtists_Items_Add_Multi_Relationship_Data_Document_Meta: required: - skipped type: object properties: skipped: type: array items: $ref: '#/components/schemas/UserCollectionArtistsItemsRelationshipAddOperation_Response_Meta_SkippedItem' 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 SearchResults_Relationships: 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' UserCollectionAlbumsItemsRelationshipAddOperation_Payload: required: - data type: object properties: data: maxItems: 20 minItems: 1 type: array items: $ref: '#/components/schemas/UserCollectionAlbumsItemsRelationshipAddOperation_Payload_Data' DynamicPages_Relationships: properties: dynamicModules: $ref: '#/components/schemas/Multi_Relationship_Data_Document' subject: $ref: '#/components/schemas/Single_Relationship_Data_Document' UserCollectionVideosItemsRelationshipAddOperation_Payload: required: - data type: object properties: data: maxItems: 20 minItems: 1 type: array items: $ref: '#/components/schemas/UserCollectionVideosItemsRelationshipAddOperation_Payload_Data' Terms_Attributes: required: - contentLink - countryCode - effectiveAt - termsType type: object properties: contentLink: $ref: '#/components/schemas/Link_Object' countryCode: type: string effectiveAt: type: string format: date-time termsType: type: string enum: - DEVELOPER - UPLOAD_MARKETPLACE UserCollectionPlaylists_Resource_Object: required: - id - type type: object properties: attributes: $ref: '#/components/schemas/UserCollectionPlaylists_Attributes' id: type: string description: Resource id example: '12345' relationships: $ref: '#/components/schemas/UserCollectionPlaylists_Relationships' type: minLength: 1 type: string description: Resource type example: tracks UserCollectionArtistsItemsRelationshipRemoveOperation_Payload_Data: required: - id - type type: object properties: id: type: string type: type: string enum: - artists 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 UserCollectionVideos_Items_Multi_Relationship_Data_Document: required: - links type: object properties: data: type: array items: $ref: '#/components/schemas/UserCollectionVideos_Items_Resource_Identifier' included: $ref: '#/components/schemas/Included' links: $ref: '#/components/schemas/Links' TrackInfo: required: - trackId type: object properties: broken: type: boolean brokenCode: type: integer format: int32 trackId: type: string 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 UserCollectionVideos_Single_Resource_Data_Document: required: - data - links type: object properties: data: $ref: '#/components/schemas/UserCollectionVideos_Resource_Object' included: $ref: '#/components/schemas/Included' links: $ref: '#/components/schemas/Links' UserDiscoveryMixes_Resource_Object: required: - id - type type: object properties: attributes: $ref: '#/components/schemas/UserDiscoveryMixes_Attributes' id: type: string description: Resource id example: '12345' relationships: $ref: '#/components/schemas/UserDiscoveryMixes_Relationships' type: minLength: 1 type: string description: Resource type example: tracks Installations_OfflineInventory_Resource_Identifier_Meta: required: - addedAt type: object properties: addedAt: type: string format: date-time UserCollectionVideos_Items_Add_Multi_Relationship_Data_Document_Meta: required: - skipped type: object properties: skipped: type: array items: $ref: '#/components/schemas/UserCollectionVideosItemsRelationshipAddOperation_Response_Meta_SkippedItem' 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' UserCollectionFoldersCreateOperation_Payload_Data: required: - attributes - type type: object properties: attributes: $ref: '#/components/schemas/UserCollectionFoldersCreateOperation_Payload_Data_Attributes' type: type: string enum: - userCollectionFolders ArtistClaims_Relationships: 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' Purchases_Resource_Object: required: - id - type type: object properties: attributes: $ref: '#/components/schemas/Purchases_Attributes' id: type: string description: Resource id example: '12345' relationships: $ref: '#/components/schemas/Purchases_Relationships' type: minLength: 1 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' 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' visualMetadata: $ref: '#/components/schemas/Artwork_VisualMetadata' UserCollectionAlbums_Resource_Object: required: - id - type type: object properties: attributes: $ref: '#/components/schemas/UserCollectionAlbums_Attributes' id: type: string description: Resource id example: '12345' relationships: $ref: '#/components/schemas/UserCollectionAlbums_Relationships' type: minLength: 1 type: string description: Resource type example: tracks UserCollectionTracks_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' UserCollectionSaveForLaters_Single_Resource_Data_Document: required: - data - links type: object properties: data: $ref: '#/components/schemas/UserCollectionSaveForLaters_Resource_Object' included: $ref: '#/components/schemas/Included' links: $ref: '#/components/schemas/Links' UserCollectionAlbums_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' TemporaryUserTokens_Attributes: type: object Installations_Relationships: properties: offlineInventory: $ref: '#/components/schemas/Installations_OfflineInventory_Multi_Relationship_Data_Document' owners: $ref: '#/components/schemas/Multi_Relationship_Data_Document' PriceConfigurations_Attributes: required: - currency - price type: object properties: currency: type: string description: Currency code (ISO 4217) enum: - USD price: type: string description: Price amount with max 2 decimal places example: '9.99' UserCollections_Videos_Resource_Identifier_Meta: required: - addedAt type: object properties: addedAt: type: string format: date-time Genres_Attributes: required: - genreName type: object properties: genreName: type: string description: Genre name example: pop UserRecommendations_Attributes: type: object UserCollectionsAlbumsRelationshipRemoveOperation_Payload: required: - data type: object properties: data: maxItems: 20 minItems: 1 type: array items: $ref: '#/components/schemas/UserCollectionsAlbumsRelationshipRemoveOperation_Payload_Data' 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 UserCollectionTracks_Single_Resource_Data_Document: required: - data - links type: object properties: data: $ref: '#/components/schemas/UserCollectionTracks_Resource_Object' included: $ref: '#/components/schemas/Included' links: $ref: '#/components/schemas/Links' 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' UserCollectionPlaylists_Attributes: type: object UserCollectionsTracksRelationshipAddOperation_Payload: required: - data type: object properties: data: maxItems: 20 minItems: 1 type: array items: $ref: '#/components/schemas/UserCollectionsTracksRelationshipAddOperation_Payload_Data' DspSharingLinks_Resource_Object: required: - id - type type: object properties: attributes: $ref: '#/components/schemas/DspSharingLinks_Attributes' id: type: string description: Resource id example: '12345' relationships: $ref: '#/components/schemas/DspSharingLinks_Relationships' type: minLength: 1 type: string description: Resource type example: tracks Videos_Attributes: required: - duration - explicit - isrc - popularity - title type: object properties: availability: type: array description: 'Available usage for this video. Deprecated: use ''usageRules'' instead. This field will be removed in a future version.' deprecated: true items: type: string deprecated: true 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 TracksMetadataStatus_Attributes: required: - status type: object properties: status: type: string description: Status of the metadata detection job enum: - PENDING - PROCESSING - ERROR - OK 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' 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 UserCollectionAlbums_Relationships: properties: items: $ref: '#/components/schemas/UserCollectionAlbums_Items_Multi_Relationship_Data_Document' owners: $ref: '#/components/schemas/Multi_Relationship_Data_Document' UserCollectionPlaylists_Items_Resource_Identifier_Meta: required: - addedAt type: object properties: addedAt: type: string format: date-time UserCollectionTracks_Relationships: properties: items: $ref: '#/components/schemas/UserCollectionTracks_Items_Multi_Relationship_Data_Document' owners: $ref: '#/components/schemas/Multi_Relationship_Data_Document' UserCollectionArtists_Items_Resource_Identifier_Meta: required: - addedAt type: object properties: addedAt: type: string format: date-time Downloads_Attributes: type: object properties: downloadLinks: type: array items: $ref: '#/components/schemas/Download_Link' UserCollectionsPlaylistsRelationshipAddOperation_Payload: required: - data type: object properties: data: maxItems: 20 minItems: 1 type: array items: $ref: '#/components/schemas/UserCollectionsPlaylistsRelationshipAddOperation_Payload_Data' UserCollectionsArtistsRelationshipAddOperation_Payload: required: - data type: object properties: data: maxItems: 20 minItems: 1 type: array items: $ref: '#/components/schemas/UserCollectionsArtistsRelationshipAddOperation_Payload_Data' UsageRules_Resource_Object: required: - id - type type: object properties: attributes: $ref: '#/components/schemas/UsageRules_Attributes' id: type: string description: Resource id example: '12345' type: minLength: 1 type: string description: Resource type example: tracks Albums_Attributes: required: - albumType - barcodeId - duration - explicit - mediaTags - numberOfItems - numberOfVolumes - popularity - title type: object properties: accessType: type: string description: Access type example: PRIVATE enum: - PUBLIC - UNLISTED - PRIVATE albumType: type: string description: Album type enum: - ALBUM - EP - SINGLE availability: type: array description: 'Available usage for this album. Deprecated: use ''usageRules'' instead. This field will be removed in a future version.' deprecated: true items: type: string deprecated: true enum: - STREAM - DJ - STEM barcodeId: type: string copyright: $ref: '#/components/schemas/Copyright' createdAt: type: string description: Datetime of album creation (ISO 8601) format: date-time 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. Deprecated: use ''albumType'' instead. This field will be removed in a future version.' deprecated: true enum: - ALBUM - EP - SINGLE version: type: string description: Album version example: remix 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' meta: $ref: '#/components/schemas/Albums_SuggestedCoverArts_Multi_Relationship_Data_Document_Meta' UserCollectionAlbumsItemsRelationshipAddOperation_Payload_Data_Meta: type: object properties: addedAt: type: string format: date-time ArtistBiographies_Relationships: properties: owners: $ref: '#/components/schemas/Multi_Relationship_Data_Document' UserCollectionTracks_Attributes: required: - numberOfItems type: object properties: lastModifiedAt: type: string description: When the collection was last modified format: date-time numberOfItems: type: integer description: Number of items in the collection format: int32 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' UserCollectionAlbums_Items_Add_Multi_Relationship_Data_Document: required: - links type: object properties: data: type: array items: $ref: '#/components/schemas/UserCollectionAlbums_Items_Resource_Identifier' included: $ref: '#/components/schemas/Included' links: $ref: '#/components/schemas/Links' meta: $ref: '#/components/schemas/UserCollectionAlbums_Items_Add_Multi_Relationship_Data_Document_Meta' 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 UserOfflineMixes_Relationships: properties: items: $ref: '#/components/schemas/Multi_Relationship_Data_Document' UserCollectionTracksItemsRelationshipAddOperation_Payload_Data_Meta: type: object properties: addedAt: type: string format: date-time 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 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 ai: type: boolean description: Whether the track is AI-generated example: false availability: type: array description: 'Available usage for this track. Deprecated: use ''usageRules'' instead. This field will be removed in a future version.' deprecated: true items: type: string deprecated: true 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 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 UserCollectionsTracksRelationshipRemoveOperation_Payload_Data: required: - id - type type: object properties: id: type: string type: type: string enum: - tracks UserCollectionVideosItemsRelationshipAddOperation_Payload_Data: required: - id - type type: object properties: id: type: string type: type: string enum: - videos 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 socialLink: $ref: '#/components/schemas/Link_Object' status: type: string description: Claim status enum: - SUBMITTED - PENDING - APPROVED - REJECTED upcs: type: array description: UPCs associated with the claim items: type: string description: UPCs associated with the claim websiteOrSocialLink: $ref: '#/components/schemas/Link_Object' ProviderProductInfos_Attributes: required: - barcodeId type: object properties: barcodeId: type: string broken: type: boolean brokenCode: type: integer format: int32 tracks: type: array items: $ref: '#/components/schemas/TrackInfo' UserCollectionsAlbumsRelationshipRemoveOperation_Payload_Data: required: - id - type type: object properties: id: type: string type: type: string enum: - albums Download_Link: required: - href - meta type: object properties: href: type: string description: URL to download the content from meta: $ref: '#/components/schemas/Download_Link_Meta' UserCollectionFoldersItemsRelationshipAddOperation_Payload_Data: required: - id - type type: object properties: id: type: string type: type: string UserDataExportRequests_Resource_Object: required: - id - type type: object properties: attributes: $ref: '#/components/schemas/UserDataExportRequests_Attributes' id: type: string description: Resource id example: '12345' type: minLength: 1 type: string description: Resource type example: tracks UsageRules_Attributes: required: - countryCode type: object properties: countryCode: type: string description: Country code (ISO 3166-1 alpha-2) free: type: array description: Usage types allowed for free/ad-supported model items: type: string description: Usage types allowed for free/ad-supported model enum: - STREAM - DJ - STEM - DOWNLOAD inherited: type: boolean description: 'Whether these usage rules are inherited from a parent (e.g. a track inheriting from its album). Tri-state: true means the rules are inherited, false means an explicit per-track override, null means the value is unknown or not applicable (albums, videos, and legacy data).' paid: type: array description: Usage types allowed for paid/purchase model items: type: string description: Usage types allowed for paid/purchase model enum: - STREAM - DJ - STEM - DOWNLOAD subscription: type: array description: Usage types allowed for subscription model items: type: string description: Usage types allowed for subscription model enum: - STREAM - DJ - STEM - DOWNLOAD validFrom: type: string description: Datetime from which these usage rules are valid (ISO 8601) format: date-time UserCollectionAlbumsItemsRelationshipAddOperation_Response_Meta_SkippedItem: required: - id - reason - type type: object properties: id: type: string reason: type: string enum: - NOT_FOUND - ALREADY_PRESENT type: type: string enum: - albums Installations_Resource_Object: required: - id - type type: object properties: attributes: $ref: '#/components/schemas/Installations_Attributes' id: type: string description: Resource id example: '12345' relationships: $ref: '#/components/schemas/Installations_Relationships' type: minLength: 1 type: string description: Resource type example: tracks UserDailyMixes_Resource_Object: required: - id - type type: object properties: attributes: $ref: '#/components/schemas/UserDailyMixes_Attributes' id: type: string description: Resource id example: '12345' relationships: $ref: '#/components/schemas/UserDailyMixes_Relationships' type: minLength: 1 type: string description: Resource type example: tracks OfflineTasks_Attributes: required: - action - position - state - volume type: object properties: action: type: string description: Action to perform enum: - STORE - REMOVE position: type: integer description: Collection position of item format: int32 state: type: string description: Task state enum: - PENDING - IN_PROGRESS - FAILED - COMPLETED volume: type: integer description: Collection volume of item format: int32 AlbumStatistics_Attributes: required: - totalPlaybacks - uniqueListeners type: object properties: numSales: type: integer description: Number of sales format: int32 totalPlaybacks: type: integer description: Total playbacks format: int32 uniqueListeners: type: integer description: Unique listeners format: int32 UserCollectionsAlbumsRelationshipAddOperation_Payload_Data: required: - id - type type: object properties: id: type: string meta: $ref: '#/components/schemas/UserCollectionsAlbumsRelationshipAddOperation_Payload_Data_Meta' type: type: string enum: - albums UserCollections_Tracks_Resource_Identifier_Meta: required: - addedAt type: object properties: addedAt: type: string format: date-time 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 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 UserCollectionSaveForLatersItemsRelationshipRemoveOperation_Payload: required: - data type: object properties: data: maxItems: 20 minItems: 1 type: array items: $ref: '#/components/schemas/UserCollectionSaveForLatersItemsRelationshipRemoveOperation_Payload_Data' TemporaryUserTokens_Relationships: properties: owners: $ref: '#/components/schemas/Multi_Relationship_Data_Document' 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 - SQUARE_AUTHORIZATION_REDIRECT description: metadata about an external link UserCollectionVideos_Relationships: properties: items: $ref: '#/components/schemas/UserCollectionVideos_Items_Multi_Relationship_Data_Document' owners: $ref: '#/components/schemas/Multi_Relationship_Data_Document' 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 UserCollectionAlbumsItemsRelationshipRemoveOperation_Payload: required: - data type: object properties: data: maxItems: 20 minItems: 1 type: array items: $ref: '#/components/schemas/UserCollectionAlbumsItemsRelationshipRemoveOperation_Payload_Data' UserCollectionArtists_Items_Resource_Identifier: required: - id - type type: object properties: id: type: string description: Resource id example: '12345' meta: $ref: '#/components/schemas/UserCollectionArtists_Items_Resource_Identifier_Meta' type: type: string description: Resource type example: tracks UserCollectionAlbumsItemsRelationshipRemoveOperation_Payload_Data: required: - id - type type: object properties: id: type: string type: type: string enum: - albums UserCollectionTracks_Items_Add_Multi_Relationship_Data_Document: required: - links type: object properties: data: type: array items: $ref: '#/components/schemas/UserCollectionTracks_Items_Resource_Identifier' included: $ref: '#/components/schemas/Included' links: $ref: '#/components/schemas/Links' meta: $ref: '#/components/schemas/UserCollectionTracks_Items_Add_Multi_Relationship_Data_Document_Meta' ThirdPartyLyricsProvider: required: - commonTrackId - lyricsId - name type: object allOf: - $ref: '#/components/schemas/LyricsProvider' - type: object properties: commonTrackId: type: string lyricsId: type: string UserCollectionTracks_Items_Add_Multi_Relationship_Data_Document_Meta: required: - skipped type: object properties: skipped: type: array items: $ref: '#/components/schemas/UserCollectionTracksItemsRelationshipAddOperation_Response_Meta_SkippedItem' 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 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 UserCollectionSaveForLaters_Items_Resource_Identifier_Meta: required: - addedAt type: object properties: addedAt: type: string format: date-time UserCollectionVideos_Items_Resource_Identifier: required: - id - type type: object properties: id: type: string description: Resource id example: '12345' meta: $ref: '#/components/schemas/UserCollectionVideos_Items_Resource_Identifier_Meta' type: type: string description: Resource type example: tracks UserCollectionsTracksRelationshipAddOperation_Payload_Data: required: - id - type type: object properties: id: type: string meta: $ref: '#/components/schemas/UserCollectionsTracksRelationshipAddOperation_Payload_Data_Meta' type: type: string enum: - tracks Installations_Attributes: required: - clientProvidedInstallationId - name type: object properties: clientProvidedInstallationId: type: string description: Client provided installation identifier name: type: string description: Human-readable name for the installation example: My iPhone 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 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 UserCollectionVideosItemsRelationshipRemoveOperation_Payload_Data: required: - id - type type: object properties: id: type: string type: type: string enum: - videos UserCollectionsVideosRelationshipAddOperation_Payload: required: - data type: object properties: data: maxItems: 20 minItems: 1 type: array items: $ref: '#/components/schemas/UserCollectionsVideosRelationshipAddOperation_Payload_Data' UserCollectionTracks_Multi_Resource_Data_Document: required: - data - links type: object properties: data: type: array items: $ref: '#/components/schemas/UserCollectionTracks_Resource_Object' included: $ref: '#/components/schemas/Included' links: $ref: '#/components/schemas/Links' 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/LegacyBarcodeId' 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 - NAME_MISMATCH - CLAIMED_ARTIST_MISMATCH ProviderOwners_Attributes: required: - createdAt type: object properties: createdAt: type: string format: date-time UserCollectionTracksItemsRelationshipRemoveOperation_Payload: required: - data type: object properties: data: maxItems: 20 minItems: 1 type: array items: $ref: '#/components/schemas/UserCollectionTracksItemsRelationshipRemoveOperation_Payload_Data' 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' UserCollectionsArtistsRelationshipRemoveOperation_Payload_Data: required: - id - type type: object properties: id: type: string type: type: string enum: - artists 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 DynamicModules_Resource_Object: required: - id - type type: object properties: attributes: $ref: '#/components/schemas/DynamicModules_Attributes' id: type: string description: Resource id example: '12345' relationships: $ref: '#/components/schemas/DynamicModules_Relationships' type: minLength: 1 type: string description: Resource type example: tracks 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 ProviderProductInfos_Resource_Object: required: - id - type type: object properties: attributes: $ref: '#/components/schemas/ProviderProductInfos_Attributes' id: type: string description: Resource id example: '12345' relationships: $ref: '#/components/schemas/ProviderProductInfos_Relationships' type: minLength: 1 type: string description: Resource type example: tracks UserCollectionFoldersItemsRelationshipRemoveOperation_Payload: type: object properties: data: maxItems: 10 minItems: 1 type: array items: $ref: '#/components/schemas/UserCollectionFoldersItemsRelationshipRemoveOperation_Payload_Data' UserCollectionPlaylists_Single_Resource_Data_Document: required: - data - links type: object properties: data: $ref: '#/components/schemas/UserCollectionPlaylists_Resource_Object' included: $ref: '#/components/schemas/Included' links: $ref: '#/components/schemas/Links' 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 UserCollectionPlaylistsItemsRelationshipRemoveOperation_Payload: required: - data type: object properties: data: maxItems: 20 minItems: 1 type: array items: $ref: '#/components/schemas/UserCollectionPlaylistsItemsRelationshipRemoveOperation_Payload_Data' UserCollectionTracks_Items_Resource_Identifier_Meta: required: - addedAt type: object properties: addedAt: type: string format: date-time Reactions_Attributes: required: - createdAt - emoji type: object properties: createdAt: type: string description: Datetime of the reaction creation (ISO 8601) format: date-time example: '2025-11-17T12:54:48.60606Z' emoji: type: string description: The type of reaction representing an emoji UserCollectionFolders_Items_Resource_Identifier_Meta: required: - addedAt type: object properties: addedAt: type: string format: date-time 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 UserCollectionsArtistsRelationshipAddOperation_Payload_Data: required: - id - type type: object properties: id: type: string meta: $ref: '#/components/schemas/UserCollectionsArtistsRelationshipAddOperation_Payload_Data_Meta' type: type: string enum: - artists UserDailyMixes_Attributes: type: object StripeConnections_Relationships: properties: owners: $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 DspSharingLinks_Attributes: type: object properties: amazonMusic: $ref: '#/components/schemas/Link_Object' appleMusic: $ref: '#/components/schemas/Link_Object' spotify: $ref: '#/components/schemas/Link_Object' youTubeMusic: $ref: '#/components/schemas/Link_Object' Downloads_Relationships: properties: owners: $ref: '#/components/schemas/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 AlbumStatistics_Resource_Object: required: - id - type type: object properties: attributes: $ref: '#/components/schemas/AlbumStatistics_Attributes' id: type: string description: Resource id example: '12345' relationships: $ref: '#/components/schemas/AlbumStatistics_Relationships' type: minLength: 1 type: string description: Resource type example: tracks 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 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 UserCollectionVideosItemsRelationshipAddOperation_Response_Meta_SkippedItem: required: - id - reason - type type: object properties: id: type: string reason: type: string enum: - NOT_FOUND - ALREADY_PRESENT type: type: string enum: - videos UserRecommendations_Relationships: 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' offlineMixes: $ref: '#/components/schemas/Multi_Relationship_Data_Document' ContentClaims_Attributes: required: - assertion - createdAt - lastModifiedAt - status type: object properties: assertion: type: string description: The claim assertion type enum: - CLAIM - DISCLAIM createdAt: type: string description: Timestamp when the claim was created format: date-time lastModifiedAt: type: string description: Timestamp when the claim was last modified format: date-time status: type: string description: Current status of this claim enum: - OPEN - IN_PROGRESS - RESOLVED - REJECTED 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 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 UserDiscoveryMixes_Attributes: type: object 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 UserCollectionSaveForLaters_Relationships: properties: items: $ref: '#/components/schemas/UserCollectionSaveForLaters_Items_Multi_Relationship_Data_Document' owners: $ref: '#/components/schemas/Multi_Relationship_Data_Document' UserCollectionArtists_Attributes: required: - numberOfItems type: object properties: lastModifiedAt: type: string description: When the collection was last modified format: date-time numberOfItems: type: integer description: Number of items in the collection format: int32 UserCollectionTracks_Items_Resource_Identifier: required: - id - type type: object properties: id: type: string description: Resource id example: '12345' meta: $ref: '#/components/schemas/UserCollectionTracks_Items_Resource_Identifier_Meta' type: type: string description: Resource type example: tracks UserCollectionVideosItemsRelationshipRemoveOperation_Payload: required: - data type: object properties: data: maxItems: 20 minItems: 1 type: array items: $ref: '#/components/schemas/UserCollectionVideosItemsRelationshipRemoveOperation_Payload_Data' SearchHistoryEntries_Attributes: required: - highlights - query type: object properties: highlights: type: array items: $ref: '#/components/schemas/Highlight' query: minLength: 1 type: string Artwork_File: required: - href type: object properties: href: type: string description: Artwork file href meta: $ref: '#/components/schemas/Artwork_File_Meta' description: Artwork files UserCollectionArtists_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' DynamicModules_Attributes: required: - icons - layoutType - moduleType - sourceType type: object properties: icons: type: array description: Type of icons the module should show example: SPOTLIGHT_ICON items: type: string description: Type of icons the module should show example: SPOTLIGHT_ICON enum: - SPOTLIGHT_INFO - UNKNOWN layoutType: type: string description: Type of representation of the items in the module view all screen example: COMPACT enum: - COMPACT - GRID - UNKNOWN moduleType: type: string description: Type of representation of the module example: HORIZONTAL_LIST enum: - ARTIST_LIST - COMPACT_GRID_CARD - COMPACT_HORIZONTAL_LIST - COMPACT_HORIZONTAL_LIST_WITH_CONTEXT - FEATURED_CARD - GRID_CARD - GRID_CARD_WITH_CONTEXT - GRID_HIGHLIGHT_CARD - ANNIVERSARY_CARD - ARTIST_BIRTHDAY_CARD - ARTIST_MEMORIAM_CARD - ARTIST_TRACK_CREDITS_CARD - PILL_LIST - VERTICAL_LIST - HORIZONTAL_LIST - HORIZONTAL_LIST_WITH_CONTEXT - SHORTCUT_LIST - TRACK_LIST - VERTICAL_LIST_CARD - TEXT_CARD - LINKS_LIST - PUBLIC_PLAYLIST_LIST sourceType: type: string description: Type of source represented by the module example: SHORTCUTS enum: - ALBUM_RECOMMENDATIONS - BECAUSE_YOU_LISTENED_TO_ALBUM - BECAUSE_YOU_ADDED_ALBUM - BECAUSE_YOU_ADDED_ARTIST - CONTINUE_LISTEN_TO - DAILY_MIXES - FORGOTTEN_FAVORITES - GENRE_MIXES - HISTORY_MIXES - LOCAL_PLAYLISTS - MY_PLAYLISTS - NEW_ALBUM_SUGGESTIONS - NEW_TRACK_SUGGESTIONS - NEW_ALBUMS - NEW_TRACKS - POPULAR_PLAYLISTS - RECENTLY_UPDATED_FAVORITED_PLAYLIST - RECOMMENDED_USERS_PLAYLISTS - SUGGESTED_ESSENTIAL_PLAYLISTS - SUGGESTED_RADIOS_MIXES - WELCOME_MIX - YOUR_FAVORITE_ARTISTS - UPLOADS_FOR_YOU - LATEST_SPOTLIGHTED_TRACKS - SHORTCUTS - ARTIST_TOP_TRACKS - ARTIST_SPOTLIGHTED_TRACKS - ARTIST_ALBUMS - ARTIST_TOP_SINGLES - ARTIST_COMPILATIONS - ARTIST_LIVE_ALBUMS - ARTIST_APPEARS_ON - ARTIST_PLAYLIST - ARTIST_PUBLIC_PLAYLIST - ARTIST_SIMILAR_ARTISTS - ARTIST_TRACK_UPLOADS - ARTIST_LINKS - ARTIST_VIDEOS - ARTIST_CREDITS - ALBUM_ITEMS - ALBUM_ANNIVERSARY - ARTIST_BIRTHDAY - ARTIST_MEMORIAM - DJ_TOOLS - DJ_ARTIST_CURATED - THE_HITS - FROM_OUR_EDITORS - TOP_PLAYLISTS - FEATURED_TOP_TRACKS - FEATURED_TOP_ALBUMS - TOP_ARTISTS_ESSENTIALS - FEATURED_RECOMMENDED_PLAYLISTS - HOME_3_FEATURED_PLAYLISTS - HOME_3_FEATURED_UPLOAD_TRACKS - HOME_3_FEATURED_ALBUMS - POPULAR_ALBUMS - POPULAR_ARTISTS - POPULAR_MIXES - FEATURED_RECOMMENDED_TRACKS - FEATURED_RECOMMENDED_ALBUMS - FEATURED_RECOMMENDED_CLASSIC_ALBUMS - BACK_TO_SCHOOL_MUSIC_101 - BACK_TO_SCHOOL_GENRES_FOR_BEGINNERS - HEADLINERS_2026 - HOME_3_0_GENERIC_PLAYLISTS_1 - HOME_3_0_GENERIC_PLAYLISTS_2 - HOME_3_0_GENERIC_ALBUMS_1 - HOME_3_0_GENERIC_TRACKS_1 - HOME_3_0_GENERIC_ARTISTS_1 - HOME_3_0_GENERIC_VIDEOS_1 - STAFF_PICKS_PAGE_ALBUMS_WE_LOVE - STAFF_PICKS_PAGE_EXPLORE - STAFF_PICKS_PAGE_FAVORITE_SONGS - STAFF_PICKS_PAGE_RECENTLY_UPDATED_PLAYLISTS - STAFF_PICKS_PAGE_TIDAL_NEWS_MAGAZINE - STAFF_PICKS_PAGE_WHAT_LISTENING_TO - BASED_ON_YOUR_INTERESTS_1 - BASED_ON_YOUR_INTERESTS_2 - UPLOAD_PAGE_SPOTLIGHTED_PLAYLISTS - UPLOAD_PAGE_PAYGATED_ALBUMS - UPLOAD_PAGE_ALBUMS - TOP_UPLOADERS - UPLOAD_PAGE_ARTISTS - UPLOAD_PAGE_FEATURED_MAGAZINE - EXPLORE_DECADES - EXPLORE_GENRES - EXPLORE_MOODS - UNKNOWN subtitle: type: string description: Subtitle of the module example: Short description of this module title: type: string description: Title of the module example: Shortcuts UserDailyMixes_Relationships: properties: items: $ref: '#/components/schemas/Multi_Relationship_Data_Document' Clients_Attributes: required: - accessTier - name type: object properties: accessTier: type: string enum: - THIRD_PARTY - THIRD_PARTY_PROD - PARTNER - INTERNAL clientSecret: type: string createdAt: type: string format: date-time description: type: string name: type: string platformPreset: type: string enum: - NONE - WEB - ANDROID - IOS redirectUris: type: array items: type: string scopes: uniqueItems: true type: array items: type: string OfflineTasks_Relationships: properties: collection: $ref: '#/components/schemas/Single_Relationship_Data_Document' item: $ref: '#/components/schemas/Single_Relationship_Data_Document' owners: $ref: '#/components/schemas/Multi_Relationship_Data_Document' Comments_Resource_Object: required: - id - type type: object properties: attributes: $ref: '#/components/schemas/Comments_Attributes' id: type: string description: Resource id example: '12345' relationships: $ref: '#/components/schemas/Comments_Relationships' type: minLength: 1 type: string description: Resource type example: tracks UserCollectionArtistsItemsRelationshipAddOperation_Response_Meta_SkippedItem: required: - id - reason - type type: object properties: id: type: string reason: type: string enum: - NOT_FOUND - ALREADY_PRESENT type: type: string enum: - artists 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' 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 source: type: string description: Source the biography is coming from example: ARTIST enum: - TIDAL - TiVo - MusicBrainz - Avex - Artist - UNKNOWN text: type: string description: Artist biography example: Once upon a time an artist is born Link_Object: type: object properties: href: type: string description: A JSON:API link object Downloads_Resource_Object: required: - id - type type: object properties: attributes: $ref: '#/components/schemas/Downloads_Attributes' id: type: string description: Resource id example: '12345' relationships: $ref: '#/components/schemas/Downloads_Relationships' type: minLength: 1 type: string description: Resource type example: tracks SearchHistoryEntries_Resource_Object: required: - id - type type: object properties: attributes: $ref: '#/components/schemas/SearchHistoryEntries_Attributes' id: type: string description: Resource id example: '12345' type: minLength: 1 type: string description: Resource type example: tracks UserCollectionArtists_Single_Resource_Data_Document: required: - data - links type: object properties: data: $ref: '#/components/schemas/UserCollectionArtists_Resource_Object' included: $ref: '#/components/schemas/Included' links: $ref: '#/components/schemas/Links' Installations_OfflineInventory_Resource_Identifier: required: - id - type type: object properties: id: type: string description: Resource id example: '12345' meta: $ref: '#/components/schemas/Installations_OfflineInventory_Resource_Identifier_Meta' type: type: string description: Resource type example: tracks 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' Resource_Identifier: required: - id - type type: object properties: id: type: string description: Resource id example: '12345' type: type: string description: Resource type example: tracks UserCollectionSaveForLaters_Items_Multi_Relationship_Data_Document: required: - links type: object properties: data: type: array items: $ref: '#/components/schemas/UserCollectionSaveForLaters_Items_Resource_Identifier' included: $ref: '#/components/schemas/Included' links: $ref: '#/components/schemas/Links' UserCollectionPlaylists_Items_Resource_Identifier: required: - id - type type: object properties: id: type: string description: Resource id example: '12345' meta: $ref: '#/components/schemas/UserCollectionPlaylists_Items_Resource_Identifier_Meta' type: type: string description: Resource type example: tracks PlayQueues_Relationships: 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' 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. Deprecated \u2014 use the history relationship instead. Will be deleted\ \ shortly." UserCollectionFoldersUpdateOperation_Payload: required: - data type: object properties: data: $ref: '#/components/schemas/UserCollectionFoldersUpdateOperation_Payload_Data' 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 UserCollectionTracksItemsRelationshipAddOperation_Payload: required: - data type: object properties: data: maxItems: 20 minItems: 1 type: array items: $ref: '#/components/schemas/UserCollectionTracksItemsRelationshipAddOperation_Payload_Data' UserCollectionTracksItemsRelationshipRemoveOperation_Payload_Data: required: - id - type type: object properties: id: type: string type: type: string enum: - tracks 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 previewReason: type: string description: Why a preview is served instead of the full track enum: - FULL_REQUIRES_SUBSCRIPTION - FULL_REQUIRES_PURCHASE - FULL_REQUIRES_HIGHER_ACCESS_TIER trackAudioNormalizationData: $ref: '#/components/schemas/AudioNormalizationData' trackPresentation: type: string description: Track presentation enum: - FULL - PREVIEW uri: type: string description: Manifest URI 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 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 Providers_Attributes: required: - name type: object properties: name: type: string description: Provider name example: Columbia/Legacy 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 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 Albums_Relationships: properties: albumStatistics: $ref: '#/components/schemas/Single_Relationship_Data_Document' 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' priceConfig: $ref: '#/components/schemas/Single_Relationship_Data_Document' providers: $ref: '#/components/schemas/Multi_Relationship_Data_Document' replacement: $ref: '#/components/schemas/Single_Relationship_Data_Document' shares: $ref: '#/components/schemas/Multi_Relationship_Data_Document' similarAlbums: $ref: '#/components/schemas/Multi_Relationship_Data_Document' suggestedCoverArts: $ref: '#/components/schemas/Albums_SuggestedCoverArts_Multi_Relationship_Data_Document' usageRules: $ref: '#/components/schemas/Single_Relationship_Data_Document' Comments_Relationships: properties: ownerProfiles: $ref: '#/components/schemas/Multi_Relationship_Data_Document' owners: $ref: '#/components/schemas/Multi_Relationship_Data_Document' parentComment: $ref: '#/components/schemas/Single_Relationship_Data_Document' 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 UserCollectionFolders_Relationships: properties: items: $ref: '#/components/schemas/UserCollectionFolders_Items_Multi_Relationship_Data_Document' owners: $ref: '#/components/schemas/Multi_Relationship_Data_Document' OfflineTasks_Resource_Object: required: - id - type type: object properties: attributes: $ref: '#/components/schemas/OfflineTasks_Attributes' id: type: string description: Resource id example: '12345' relationships: $ref: '#/components/schemas/OfflineTasks_Relationships' type: minLength: 1 type: string description: Resource type example: tracks UserCollectionVideos_Resource_Object: required: - id - type type: object properties: attributes: $ref: '#/components/schemas/UserCollectionVideos_Attributes' id: type: string description: Resource id example: '12345' relationships: $ref: '#/components/schemas/UserCollectionVideos_Relationships' type: minLength: 1 type: string description: Resource type example: tracks UserCollectionSaveForLaters_Attributes: required: - numberOfItems type: object properties: lastModifiedAt: type: string description: When the collection was last modified format: date-time numberOfItems: type: integer description: Number of items in the collection format: int32 Artists_Relationships: 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' UserCollectionTracks_Items_Multi_Relationship_Data_Document: required: - links type: object properties: data: type: array items: $ref: '#/components/schemas/UserCollectionTracks_Items_Resource_Identifier' included: $ref: '#/components/schemas/Included' links: $ref: '#/components/schemas/Links' UserCollections_Albums_Resource_Identifier_Meta: required: - addedAt type: object properties: addedAt: type: string format: date-time 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 UserCollectionAlbums_Items_Resource_Identifier: required: - id - type type: object properties: id: type: string description: Resource id example: '12345' meta: $ref: '#/components/schemas/UserCollectionAlbums_Items_Resource_Identifier_Meta' type: type: string description: Resource type example: tracks UserCollectionArtistsItemsRelationshipAddOperation_Payload_Data_Meta: type: object properties: addedAt: type: string format: date-time LegacySource: required: - id - type type: object properties: id: type: string type: type: string TidalLyricsProvider: type: object allOf: - $ref: '#/components/schemas/LyricsProvider' UserCollectionsVideosRelationshipRemoveOperation_Payload: required: - data type: object properties: data: maxItems: 20 minItems: 1 type: array items: $ref: '#/components/schemas/UserCollectionsVideosRelationshipRemoveOperation_Payload_Data' Single_Relationship_Data_Document: required: - links type: object properties: data: $ref: '#/components/schemas/Resource_Identifier' links: $ref: '#/components/schemas/Links' VideoManifests_Resource_Object: required: - id - type type: object properties: attributes: $ref: '#/components/schemas/VideoManifests_Attributes' id: type: string description: Resource id example: '12345' type: minLength: 1 type: string description: Resource type example: tracks UserCollectionsAlbumsRelationshipAddOperation_Payload: required: - data type: object properties: data: maxItems: 20 minItems: 1 type: array items: $ref: '#/components/schemas/UserCollectionsAlbumsRelationshipAddOperation_Payload_Data' AudioNormalizationData: type: object properties: peakAmplitude: type: number format: float replayGain: type: number format: float description: Track normalization data 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 AcceptedTerms_Resource_Object: required: - id - type type: object properties: attributes: $ref: '#/components/schemas/AcceptedTerms_Attributes' id: type: string description: Resource id example: '12345' relationships: $ref: '#/components/schemas/AcceptedTerms_Relationships' type: minLength: 1 type: string description: Resource type example: tracks ProviderOwners_Resource_Object: required: - id - type type: object properties: attributes: $ref: '#/components/schemas/ProviderOwners_Attributes' id: type: string description: Resource id example: '12345' relationships: $ref: '#/components/schemas/ProviderOwners_Relationships' type: minLength: 1 type: string description: Resource type example: tracks Clients_Relationships: properties: owners: $ref: '#/components/schemas/Multi_Relationship_Data_Document' UserCollectionPlaylists_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_Relationships: properties: ownerProfiles: $ref: '#/components/schemas/Multi_Relationship_Data_Document' owners: $ref: '#/components/schemas/Multi_Relationship_Data_Document' Artwork_VisualMetadata: type: object properties: blurHash: type: string description: BlurHash representation of the artwork for placeholder display selectedPaletteColor: type: string description: Selected color from the extracted artwork palette status: type: string description: Status of visual metadata extraction enum: - NONE - PROCESSING - OK description: Color information extracted from artwork AlbumStatistics_Relationships: properties: owners: $ref: '#/components/schemas/Multi_Relationship_Data_Document' UserCollectionsPlaylistsRelationshipRemoveOperation_Payload_Data: required: - id - type type: object properties: id: type: string type: type: string enum: - playlists Included: type: array items: discriminator: mapping: acceptedTerms: '#/components/schemas/AcceptedTerms_Resource_Object' albumStatistics: '#/components/schemas/AlbumStatistics_Resource_Object' 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' clients: '#/components/schemas/Clients_Resource_Object' comments: '#/components/schemas/Comments_Resource_Object' contentClaims: '#/components/schemas/ContentClaims_Resource_Object' credits: '#/components/schemas/Credits_Resource_Object' downloads: '#/components/schemas/Downloads_Resource_Object' dspSharingLinks: '#/components/schemas/DspSharingLinks_Resource_Object' dynamicModules: '#/components/schemas/DynamicModules_Resource_Object' dynamicPages: '#/components/schemas/DynamicPages_Resource_Object' genres: '#/components/schemas/Genres_Resource_Object' installations: '#/components/schemas/Installations_Resource_Object' lyrics: '#/components/schemas/Lyrics_Resource_Object' manualArtistClaims: '#/components/schemas/ManualArtistClaims_Resource_Object' offlineTasks: '#/components/schemas/OfflineTasks_Resource_Object' playQueues: '#/components/schemas/PlayQueues_Resource_Object' playlists: '#/components/schemas/Playlists_Resource_Object' priceConfigurations: '#/components/schemas/PriceConfigurations_Resource_Object' providerOwners: '#/components/schemas/ProviderOwners_Resource_Object' providerProductInfos: '#/components/schemas/ProviderProductInfos_Resource_Object' providers: '#/components/schemas/Providers_Resource_Object' purchases: '#/components/schemas/Purchases_Resource_Object' reactions: '#/components/schemas/Reactions_Resource_Object' savedShares: '#/components/schemas/SavedShares_Resource_Object' searchHistoryEntries: '#/components/schemas/SearchHistoryEntries_Resource_Object' searchResults: '#/components/schemas/SearchResults_Resource_Object' searchSuggestions: '#/components/schemas/SearchSuggestions_Resource_Object' shares: '#/components/schemas/Shares_Resource_Object' squareConnections: '#/components/schemas/SquareConnections_Resource_Object' stripeConnections: '#/components/schemas/StripeConnections_Resource_Object' stripeDashboardLinks: '#/components/schemas/StripeDashboardLinks_Resource_Object' temporaryUserTokens: '#/components/schemas/TemporaryUserTokens_Resource_Object' terms: '#/components/schemas/Terms_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' tracksMetadataStatus: '#/components/schemas/TracksMetadataStatus_Resource_Object' usageRules: '#/components/schemas/UsageRules_Resource_Object' userCollectionAlbums: '#/components/schemas/UserCollectionAlbums_Resource_Object' userCollectionArtists: '#/components/schemas/UserCollectionArtists_Resource_Object' userCollectionFolders: '#/components/schemas/UserCollectionFolders_Resource_Object' userCollectionPlaylists: '#/components/schemas/UserCollectionPlaylists_Resource_Object' userCollectionSaveForLaters: '#/components/schemas/UserCollectionSaveForLaters_Resource_Object' userCollectionTracks: '#/components/schemas/UserCollectionTracks_Resource_Object' userCollectionVideos: '#/components/schemas/UserCollectionVideos_Resource_Object' userCollections: '#/components/schemas/UserCollections_Resource_Object' userDailyMixes: '#/components/schemas/UserDailyMixes_Resource_Object' userDataExportRequests: '#/components/schemas/UserDataExportRequests_Resource_Object' userDiscoveryMixes: '#/components/schemas/UserDiscoveryMixes_Resource_Object' userNewReleaseMixes: '#/components/schemas/UserNewReleaseMixes_Resource_Object' userOfflineMixes: '#/components/schemas/UserOfflineMixes_Resource_Object' userRecommendations: '#/components/schemas/UserRecommendations_Resource_Object' userReports: '#/components/schemas/UserReports_Resource_Object' users: '#/components/schemas/Users_Resource_Object' videoManifests: '#/components/schemas/VideoManifests_Resource_Object' videos: '#/components/schemas/Videos_Resource_Object' propertyName: type oneOf: - $ref: '#/components/schemas/AcceptedTerms_Resource_Object' - $ref: '#/components/schemas/AlbumStatistics_Resource_Object' - $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/Clients_Resource_Object' - $ref: '#/components/schemas/Comments_Resource_Object' - $ref: '#/components/schemas/ContentClaims_Resource_Object' - $ref: '#/components/schemas/Credits_Resource_Object' - $ref: '#/components/schemas/Downloads_Resource_Object' - $ref: '#/components/schemas/DspSharingLinks_Resource_Object' - $ref: '#/components/schemas/DynamicModules_Resource_Object' - $ref: '#/components/schemas/DynamicPages_Resource_Object' - $ref: '#/components/schemas/Genres_Resource_Object' - $ref: '#/components/schemas/Installations_Resource_Object' - $ref: '#/components/schemas/Lyrics_Resource_Object' - $ref: '#/components/schemas/ManualArtistClaims_Resource_Object' - $ref: '#/components/schemas/OfflineTasks_Resource_Object' - $ref: '#/components/schemas/PlayQueues_Resource_Object' - $ref: '#/components/schemas/Playlists_Resource_Object' - $ref: '#/components/schemas/PriceConfigurations_Resource_Object' - $ref: '#/components/schemas/ProviderOwners_Resource_Object' - $ref: '#/components/schemas/ProviderProductInfos_Resource_Object' - $ref: '#/components/schemas/Providers_Resource_Object' - $ref: '#/components/schemas/Purchases_Resource_Object' - $ref: '#/components/schemas/Reactions_Resource_Object' - $ref: '#/components/schemas/SavedShares_Resource_Object' - $ref: '#/components/schemas/SearchHistoryEntries_Resource_Object' - $ref: '#/components/schemas/SearchResults_Resource_Object' - $ref: '#/components/schemas/SearchSuggestions_Resource_Object' - $ref: '#/components/schemas/Shares_Resource_Object' - $ref: '#/components/schemas/SquareConnections_Resource_Object' - $ref: '#/components/schemas/StripeConnections_Resource_Object' - $ref: '#/components/schemas/StripeDashboardLinks_Resource_Object' - $ref: '#/components/schemas/TemporaryUserTokens_Resource_Object' - $ref: '#/components/schemas/Terms_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/TracksMetadataStatus_Resource_Object' - $ref: '#/components/schemas/UsageRules_Resource_Object' - $ref: '#/components/schemas/UserCollectionAlbums_Resource_Object' - $ref: '#/components/schemas/UserCollectionArtists_Resource_Object' - $ref: '#/components/schemas/UserCollectionFolders_Resource_Object' - $ref: '#/components/schemas/UserCollectionPlaylists_Resource_Object' - $ref: '#/components/schemas/UserCollectionSaveForLaters_Resource_Object' - $ref: '#/components/schemas/UserCollectionTracks_Resource_Object' - $ref: '#/components/schemas/UserCollectionVideos_Resource_Object' - $ref: '#/components/schemas/UserCollections_Resource_Object' - $ref: '#/components/schemas/UserDailyMixes_Resource_Object' - $ref: '#/components/schemas/UserDataExportRequests_Resource_Object' - $ref: '#/components/schemas/UserDiscoveryMixes_Resource_Object' - $ref: '#/components/schemas/UserNewReleaseMixes_Resource_Object' - $ref: '#/components/schemas/UserOfflineMixes_Resource_Object' - $ref: '#/components/schemas/UserRecommendations_Resource_Object' - $ref: '#/components/schemas/UserReports_Resource_Object' - $ref: '#/components/schemas/Users_Resource_Object' - $ref: '#/components/schemas/VideoManifests_Resource_Object' - $ref: '#/components/schemas/Videos_Resource_Object' Playlists_Relationships: properties: collaboratorProfiles: $ref: '#/components/schemas/Multi_Relationship_Data_Document' collaborators: $ref: '#/components/schemas/Multi_Relationship_Data_Document' 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' 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' UserCollectionPlaylists_Items_Multi_Relationship_Data_Document: required: - links type: object properties: data: type: array items: $ref: '#/components/schemas/UserCollectionPlaylists_Items_Resource_Identifier' included: $ref: '#/components/schemas/Included' links: $ref: '#/components/schemas/Links' Tracks_Relationships: properties: albums: $ref: '#/components/schemas/Multi_Relationship_Data_Document' artists: $ref: '#/components/schemas/Multi_Relationship_Data_Document' credits: $ref: '#/components/schemas/Multi_Relationship_Data_Document' download: $ref: '#/components/schemas/Single_Relationship_Data_Document' genres: $ref: '#/components/schemas/Multi_Relationship_Data_Document' lyrics: $ref: '#/components/schemas/Multi_Relationship_Data_Document' metadataStatus: $ref: '#/components/schemas/Single_Relationship_Data_Document' owners: $ref: '#/components/schemas/Multi_Relationship_Data_Document' priceConfig: $ref: '#/components/schemas/Single_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' suggestedTracks: $ref: '#/components/schemas/Multi_Relationship_Data_Document' trackStatistics: $ref: '#/components/schemas/Single_Relationship_Data_Document' usageRules: $ref: '#/components/schemas/Single_Relationship_Data_Document' 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' External_Link: required: - href - meta type: object properties: href: type: string meta: $ref: '#/components/schemas/External_Link_Meta' UserCollectionSaveForLaters_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_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 ownerType: type: string description: 'Ownership type of the artist profile. LABEL: label-managed profile, USER: user-created profile, MIXED: claimed profile with both label and user content. May be null during rollout/backfill.' enum: - LABEL - USER - MIXED 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 TrackStatistics_Attributes: required: - totalPlaybacks - uniqueListeners type: object properties: totalPlaybacks: type: integer description: Total playbacks format: int32 uniqueListeners: type: integer description: Unique listeners format: int32 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 UserCollectionsTracksRelationshipRemoveOperation_Payload: required: - data type: object properties: data: maxItems: 20 minItems: 1 type: array items: $ref: '#/components/schemas/UserCollectionsTracksRelationshipRemoveOperation_Payload_Data' UserCollectionVideos_Items_Add_Multi_Relationship_Data_Document: required: - links type: object properties: data: type: array items: $ref: '#/components/schemas/UserCollectionVideos_Items_Resource_Identifier' included: $ref: '#/components/schemas/Included' links: $ref: '#/components/schemas/Links' meta: $ref: '#/components/schemas/UserCollectionVideos_Items_Add_Multi_Relationship_Data_Document_Meta' UserCollectionAlbums_Items_Resource_Identifier_Meta: required: - addedAt type: object properties: addedAt: type: string format: date-time 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 Comments_Attributes: required: - createdAt - lastModifiedAt - likeCount - message - moderationStatus - replyCount type: object properties: createdAt: type: string description: Datetime when the comment was created (ISO 8601) format: date-time example: '2025-11-17T12:54:48.606Z' endTime: type: string description: End time offset for timestamped comments (ISO 8601 duration) example: PT2M lastModifiedAt: type: string description: Datetime when the comment was last modified (ISO 8601) format: date-time example: '2025-11-17T12:54:48.606Z' likeCount: type: integer description: Number of likes on this comment format: int32 message: maxLength: 2000 minLength: 1 type: string description: The comment message content moderationStatus: type: string description: Moderation status of the comment enum: - NOT_MODERATED - FLAGGED - TAKEN_DOWN - OK - ERROR replyCount: type: integer description: Number of replies to this comment format: int32 startTime: type: string description: Start time offset for timestamped comments (ISO 8601 duration) example: PT1M30S UserCollectionsVideosRelationshipRemoveOperation_Payload_Data: required: - id - type type: object properties: id: type: string type: type: string enum: - videos TrackSourceFiles_Relationships: properties: owners: $ref: '#/components/schemas/Multi_Relationship_Data_Document' 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 UserCollectionTracksItemsRelationshipAddOperation_Payload_Data: required: - id - type type: object properties: id: type: string meta: $ref: '#/components/schemas/UserCollectionTracksItemsRelationshipAddOperation_Payload_Data_Meta' type: type: string enum: - tracks Artworks_Relationships: properties: owners: $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 Artists_Followers_Resource_Identifier_Meta: type: object properties: viewer: $ref: '#/components/schemas/Artists_Followers_Resource_Meta_ViewerContext' 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 UserCollectionArtists_Relationships: properties: items: $ref: '#/components/schemas/UserCollectionArtists_Items_Multi_Relationship_Data_Document' owners: $ref: '#/components/schemas/Multi_Relationship_Data_Document' UserCollectionFoldersItemsRelationshipRemoveOperation_Payload_Data: required: - id - type type: object properties: id: type: string type: type: string AcceptedTerms_Relationships: properties: owners: $ref: '#/components/schemas/Multi_Relationship_Data_Document' terms: $ref: '#/components/schemas/Single_Relationship_Data_Document' StripeDashboardLinks_Attributes: type: object properties: dashboardLink: $ref: '#/components/schemas/Link_Object' UserCollectionArtists_Items_Multi_Relationship_Data_Document: required: - links type: object properties: data: type: array items: $ref: '#/components/schemas/UserCollectionArtists_Items_Resource_Identifier' included: $ref: '#/components/schemas/Included' links: $ref: '#/components/schemas/Links' UserCollectionAlbums_Items_Add_Multi_Relationship_Data_Document_Meta: required: - skipped type: object properties: skipped: type: array items: $ref: '#/components/schemas/UserCollectionAlbumsItemsRelationshipAddOperation_Response_Meta_SkippedItem' 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 Lyrics_Relationships: properties: owners: $ref: '#/components/schemas/Multi_Relationship_Data_Document' track: $ref: '#/components/schemas/Single_Relationship_Data_Document' Playlists_Items_Resource_Identifier_Meta: type: object properties: addedAt: type: string format: date-time itemId: type: string ContentClaims_Relationships: properties: claimedResource: $ref: '#/components/schemas/Single_Relationship_Data_Document' claimingArtist: $ref: '#/components/schemas/Single_Relationship_Data_Document' owners: $ref: '#/components/schemas/Multi_Relationship_Data_Document' 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' 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' UserCollectionsVideosRelationshipAddOperation_Payload_Data: required: - id - type type: object properties: id: type: string type: type: string enum: - videos UserCollectionFoldersCreateOperation_Payload: required: - data type: object properties: data: $ref: '#/components/schemas/UserCollectionFoldersCreateOperation_Payload_Data' 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 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' UserCollectionSaveForLaters_Items_Resource_Identifier: required: - id - type type: object properties: id: type: string description: Resource id example: '12345' meta: $ref: '#/components/schemas/UserCollectionSaveForLaters_Items_Resource_Identifier_Meta' type: type: string description: Resource type example: tracks Highlight: type: object properties: length: type: integer format: int32 start: type: integer format: int32 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 UserCollectionTracksItemsRelationshipAddOperation_Response_Meta_SkippedItem: required: - id - reason - type type: object properties: id: type: string reason: type: string enum: - NOT_FOUND - ALREADY_PRESENT type: type: string enum: - tracks 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 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 LegacyBarcodeId: type: object properties: value: type: string description: List of UPCs retrieved from the DSP UserCollectionVideos_Attributes: required: - numberOfItems type: object properties: lastModifiedAt: type: string description: When the collection was last modified format: date-time numberOfItems: type: integer description: Number of items in the collection format: int32 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 SearchSuggestions_Attributes: required: - trackingId type: object properties: history: type: array description: "Suggestions from search history. Deprecated \u2014 use the history relationship instead. Will be deleted\ \ shortly." deprecated: true 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 UserCollectionSaveForLaters_Resource_Object: required: - id - type type: object properties: attributes: $ref: '#/components/schemas/UserCollectionSaveForLaters_Attributes' id: type: string description: Resource id example: '12345' relationships: $ref: '#/components/schemas/UserCollectionSaveForLaters_Relationships' type: minLength: 1 type: string description: Resource type example: tracks 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 UserCollectionAlbumsItemsRelationshipAddOperation_Payload_Data: required: - id - type type: object properties: id: type: string meta: $ref: '#/components/schemas/UserCollectionAlbumsItemsRelationshipAddOperation_Payload_Data_Meta' type: type: string enum: - albums UserCollectionPlaylistsItemsRelationshipAddOperation_Payload: required: - data type: object properties: data: maxItems: 20 minItems: 1 type: array items: $ref: '#/components/schemas/UserCollectionPlaylistsItemsRelationshipAddOperation_Payload_Data' Terms_Resource_Object: required: - id - type type: object properties: attributes: $ref: '#/components/schemas/Terms_Attributes' id: type: string description: Resource id example: '12345' type: minLength: 1 type: string description: Resource type example: tracks TemporaryUserTokens_Resource_Object: required: - id - type type: object properties: attributes: $ref: '#/components/schemas/TemporaryUserTokens_Attributes' id: type: string description: Resource id example: '12345' relationships: $ref: '#/components/schemas/TemporaryUserTokens_Relationships' type: minLength: 1 type: string description: Resource type example: tracks 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' Albums_SuggestedCoverArts_Multi_Relationship_Data_Document_Meta: type: object properties: status: type: string enum: - PENDING - PROCESSING - ERROR - OK 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' 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' 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 UserCollectionsAlbumsRelationshipAddOperation_Payload_Data_Meta: type: object properties: addedAt: type: string format: date-time UserCollectionSaveForLaters_Items_Add_Multi_Relationship_Data_Document_Meta: required: - skipped type: object properties: skipped: type: array items: $ref: '#/components/schemas/UserCollectionSaveForLatersItemsRelationshipAddOperation_Response_Meta_SkippedItem' 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' 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 UserCollectionArtistsItemsRelationshipAddOperation_Payload_Data: required: - id - type type: object properties: id: type: string meta: $ref: '#/components/schemas/UserCollectionArtistsItemsRelationshipAddOperation_Payload_Data_Meta' type: type: string enum: - artists UserCollectionAlbums_Single_Resource_Data_Document: required: - data - links type: object properties: data: $ref: '#/components/schemas/UserCollectionAlbums_Resource_Object' included: $ref: '#/components/schemas/Included' links: $ref: '#/components/schemas/Links' UserNewReleaseMixes_Relationships: properties: items: $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 PriceConfigurations_Resource_Object: required: - id - type type: object properties: attributes: $ref: '#/components/schemas/PriceConfigurations_Attributes' id: type: string description: Resource id example: '12345' type: minLength: 1 type: string description: Resource type example: tracks 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 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. r_usr: Read access to all end user data recommendations.read: "Read access to a user\u2019s 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. w_usr: Write user 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 r_usr: INTERNAL recommendations.read: THIRD_PARTY search.read: THIRD_PARTY search.write: THIRD_PARTY user.read: THIRD_PARTY w_usr: INTERNAL 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