{ "opencollection": "1.0.0", "info": { "name": "TIDAL User Collections API", "version": "1.10.14" }, "items": [ { "info": { "name": "userCollectionAlbums", "type": "folder" }, "items": [ { "info": { "name": "Get single userCollectionAlbum.", "type": "http" }, "http": { "method": "GET", "url": "https://openapi.tidal.com/v2/userCollectionAlbums/:id", "params": [ { "name": "id", "value": "me", "type": "path", "description": "User collection albums id. Use `me` for the authenticated user's resource" }, { "name": "countryCode", "value": "US", "type": "query", "description": "ISO 3166-1 alpha-2 country code" }, { "name": "locale", "value": "en-US", "type": "query", "description": "BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported." }, { "name": "include", "value": "items", "type": "query", "description": "Allows the client to customize which related resources should be returned. Available options: items, owners" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://login.tidal.com/authorize", "accessTokenUrl": "https://auth.tidal.com/v1/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves single userCollectionAlbum by id." }, { "info": { "name": "Get items relationship (\"to-many\").", "type": "http" }, "http": { "method": "GET", "url": "https://openapi.tidal.com/v2/userCollectionAlbums/:id/relationships/items", "params": [ { "name": "id", "value": "me", "type": "path", "description": "User collection albums id. Use `me` for the authenticated user's resource" }, { "name": "page[cursor]", "value": "", "type": "query", "description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified" }, { "name": "sort", "value": "", "type": "query", "description": "Values prefixed with \"-\" are sorted descending; values without it are sorted ascending." }, { "name": "countryCode", "value": "US", "type": "query", "description": "ISO 3166-1 alpha-2 country code" }, { "name": "locale", "value": "en-US", "type": "query", "description": "BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported." }, { "name": "include", "value": "items", "type": "query", "description": "Allows the client to customize which related resources should be returned. Available options: items" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://login.tidal.com/authorize", "accessTokenUrl": "https://auth.tidal.com/v1/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves items relationship." }, { "info": { "name": "Add to items relationship (\"to-many\").", "type": "http" }, "http": { "method": "POST", "url": "https://openapi.tidal.com/v2/userCollectionAlbums/:id/relationships/items", "params": [ { "name": "id", "value": "me", "type": "path", "description": "User collection albums id. Use `me` for the authenticated user's resource" }, { "name": "countryCode", "value": "US", "type": "query", "description": "ISO 3166-1 alpha-2 country code" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://login.tidal.com/authorize", "accessTokenUrl": "https://auth.tidal.com/v1/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Adds item(s) to items relationship." }, { "info": { "name": "Delete from items relationship (\"to-many\").", "type": "http" }, "http": { "method": "DELETE", "url": "https://openapi.tidal.com/v2/userCollectionAlbums/:id/relationships/items", "params": [ { "name": "id", "value": "me", "type": "path", "description": "User collection albums id. Use `me` for the authenticated user's resource" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://login.tidal.com/authorize", "accessTokenUrl": "https://auth.tidal.com/v1/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deletes item(s) from items relationship." }, { "info": { "name": "Get owners relationship (\"to-many\").", "type": "http" }, "http": { "method": "GET", "url": "https://openapi.tidal.com/v2/userCollectionAlbums/:id/relationships/owners", "params": [ { "name": "id", "value": "me", "type": "path", "description": "User collection albums id. Use `me` for the authenticated user's resource" }, { "name": "include", "value": "owners", "type": "query", "description": "Allows the client to customize which related resources should be returned. Available options: owners" }, { "name": "page[cursor]", "value": "", "type": "query", "description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://login.tidal.com/authorize", "accessTokenUrl": "https://auth.tidal.com/v1/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves owners relationship." } ] }, { "info": { "name": "userCollectionArtists", "type": "folder" }, "items": [ { "info": { "name": "Get single userCollectionArtist.", "type": "http" }, "http": { "method": "GET", "url": "https://openapi.tidal.com/v2/userCollectionArtists/:id", "params": [ { "name": "id", "value": "me", "type": "path", "description": "User collection artists id. Use `me` for the authenticated user's resource" }, { "name": "countryCode", "value": "US", "type": "query", "description": "ISO 3166-1 alpha-2 country code" }, { "name": "locale", "value": "en-US", "type": "query", "description": "BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported." }, { "name": "include", "value": "items", "type": "query", "description": "Allows the client to customize which related resources should be returned. Available options: items, owners" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://login.tidal.com/authorize", "accessTokenUrl": "https://auth.tidal.com/v1/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves single userCollectionArtist by id." }, { "info": { "name": "Get items relationship (\"to-many\").", "type": "http" }, "http": { "method": "GET", "url": "https://openapi.tidal.com/v2/userCollectionArtists/:id/relationships/items", "params": [ { "name": "id", "value": "me", "type": "path", "description": "User collection artists id. Use `me` for the authenticated user's resource" }, { "name": "page[cursor]", "value": "", "type": "query", "description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified" }, { "name": "sort", "value": "", "type": "query", "description": "Values prefixed with \"-\" are sorted descending; values without it are sorted ascending." }, { "name": "countryCode", "value": "US", "type": "query", "description": "ISO 3166-1 alpha-2 country code" }, { "name": "locale", "value": "en-US", "type": "query", "description": "BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported." }, { "name": "include", "value": "items", "type": "query", "description": "Allows the client to customize which related resources should be returned. Available options: items" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://login.tidal.com/authorize", "accessTokenUrl": "https://auth.tidal.com/v1/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves items relationship." }, { "info": { "name": "Add to items relationship (\"to-many\").", "type": "http" }, "http": { "method": "POST", "url": "https://openapi.tidal.com/v2/userCollectionArtists/:id/relationships/items", "params": [ { "name": "id", "value": "me", "type": "path", "description": "User collection artists id. Use `me` for the authenticated user's resource" }, { "name": "countryCode", "value": "US", "type": "query", "description": "ISO 3166-1 alpha-2 country code" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://login.tidal.com/authorize", "accessTokenUrl": "https://auth.tidal.com/v1/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Adds item(s) to items relationship." }, { "info": { "name": "Delete from items relationship (\"to-many\").", "type": "http" }, "http": { "method": "DELETE", "url": "https://openapi.tidal.com/v2/userCollectionArtists/:id/relationships/items", "params": [ { "name": "id", "value": "me", "type": "path", "description": "User collection artists id. Use `me` for the authenticated user's resource" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://login.tidal.com/authorize", "accessTokenUrl": "https://auth.tidal.com/v1/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deletes item(s) from items relationship." }, { "info": { "name": "Get owners relationship (\"to-many\").", "type": "http" }, "http": { "method": "GET", "url": "https://openapi.tidal.com/v2/userCollectionArtists/:id/relationships/owners", "params": [ { "name": "id", "value": "me", "type": "path", "description": "User collection artists id. Use `me` for the authenticated user's resource" }, { "name": "include", "value": "owners", "type": "query", "description": "Allows the client to customize which related resources should be returned. Available options: owners" }, { "name": "page[cursor]", "value": "", "type": "query", "description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://login.tidal.com/authorize", "accessTokenUrl": "https://auth.tidal.com/v1/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves owners relationship." } ] }, { "info": { "name": "userCollectionFolders", "type": "folder" }, "items": [ { "info": { "name": "Get multiple userCollectionFolders.", "type": "http" }, "http": { "method": "GET", "url": "https://openapi.tidal.com/v2/userCollectionFolders", "params": [ { "name": "include", "value": "items", "type": "query", "description": "Allows the client to customize which related resources should be returned. Available options: items, owners" }, { "name": "filter[id]", "value": "", "type": "query", "description": "Folder Id (e.g. `CBMHXUOuJZgroV2kWpeVLL1I7xdgvF6ocDEGCXov8SZq3WVhrOcOq5pjnGawKX`)" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://login.tidal.com/authorize", "accessTokenUrl": "https://auth.tidal.com/v1/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves multiple userCollectionFolders by available filters, or without if applicable." }, { "info": { "name": "Create single userCollectionFolder.", "type": "http" }, "http": { "method": "POST", "url": "https://openapi.tidal.com/v2/userCollectionFolders", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://login.tidal.com/authorize", "accessTokenUrl": "https://auth.tidal.com/v1/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a new userCollectionFolder." }, { "info": { "name": "Get single userCollectionFolder.", "type": "http" }, "http": { "method": "GET", "url": "https://openapi.tidal.com/v2/userCollectionFolders/:id", "params": [ { "name": "id", "value": "CBMHXUOuJZgroV2kWpeVLL1I7xdgvF6ocDEGCXov8SZq3WVhrOcOq5pjnGawKX", "type": "path", "description": "Folder Id" }, { "name": "include", "value": "items", "type": "query", "description": "Allows the client to customize which related resources should be returned. Available options: items, owners" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://login.tidal.com/authorize", "accessTokenUrl": "https://auth.tidal.com/v1/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves single userCollectionFolder by id." }, { "info": { "name": "Update single userCollectionFolder.", "type": "http" }, "http": { "method": "PATCH", "url": "https://openapi.tidal.com/v2/userCollectionFolders/:id", "params": [ { "name": "id", "value": "CBMHXUOuJZgroV2kWpeVLL1I7xdgvF6ocDEGCXov8SZq3WVhrOcOq5pjnGawKX", "type": "path", "description": "Folder Id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://login.tidal.com/authorize", "accessTokenUrl": "https://auth.tidal.com/v1/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates existing userCollectionFolder." }, { "info": { "name": "Delete single userCollectionFolder.", "type": "http" }, "http": { "method": "DELETE", "url": "https://openapi.tidal.com/v2/userCollectionFolders/:id", "params": [ { "name": "id", "value": "CBMHXUOuJZgroV2kWpeVLL1I7xdgvF6ocDEGCXov8SZq3WVhrOcOq5pjnGawKX", "type": "path", "description": "Folder Id" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://login.tidal.com/authorize", "accessTokenUrl": "https://auth.tidal.com/v1/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deletes existing userCollectionFolder." }, { "info": { "name": "Get items relationship (\"to-many\").", "type": "http" }, "http": { "method": "GET", "url": "https://openapi.tidal.com/v2/userCollectionFolders/:id/relationships/items", "params": [ { "name": "id", "value": "CBMHXUOuJZgroV2kWpeVLL1I7xdgvF6ocDEGCXov8SZq3WVhrOcOq5pjnGawKX", "type": "path", "description": "Folder Id" }, { "name": "page[cursor]", "value": "", "type": "query", "description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified" }, { "name": "sort", "value": "", "type": "query", "description": "Values prefixed with \"-\" are sorted descending; values without it are sorted ascending." }, { "name": "include", "value": "items", "type": "query", "description": "Allows the client to customize which related resources should be returned. Available options: items" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://login.tidal.com/authorize", "accessTokenUrl": "https://auth.tidal.com/v1/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves items relationship." }, { "info": { "name": "Add to items relationship (\"to-many\").", "type": "http" }, "http": { "method": "POST", "url": "https://openapi.tidal.com/v2/userCollectionFolders/:id/relationships/items", "params": [ { "name": "id", "value": "CBMHXUOuJZgroV2kWpeVLL1I7xdgvF6ocDEGCXov8SZq3WVhrOcOq5pjnGawKX", "type": "path", "description": "Folder Id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://login.tidal.com/authorize", "accessTokenUrl": "https://auth.tidal.com/v1/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Adds item(s) to items relationship." }, { "info": { "name": "Delete from items relationship (\"to-many\").", "type": "http" }, "http": { "method": "DELETE", "url": "https://openapi.tidal.com/v2/userCollectionFolders/:id/relationships/items", "params": [ { "name": "id", "value": "CBMHXUOuJZgroV2kWpeVLL1I7xdgvF6ocDEGCXov8SZq3WVhrOcOq5pjnGawKX", "type": "path", "description": "Folder Id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://login.tidal.com/authorize", "accessTokenUrl": "https://auth.tidal.com/v1/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deletes item(s) from items relationship." }, { "info": { "name": "Get owners relationship (\"to-many\").", "type": "http" }, "http": { "method": "GET", "url": "https://openapi.tidal.com/v2/userCollectionFolders/:id/relationships/owners", "params": [ { "name": "id", "value": "CBMHXUOuJZgroV2kWpeVLL1I7xdgvF6ocDEGCXov8SZq3WVhrOcOq5pjnGawKX", "type": "path", "description": "Folder Id" }, { "name": "include", "value": "owners", "type": "query", "description": "Allows the client to customize which related resources should be returned. Available options: owners" }, { "name": "page[cursor]", "value": "", "type": "query", "description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://login.tidal.com/authorize", "accessTokenUrl": "https://auth.tidal.com/v1/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves owners relationship." } ] }, { "info": { "name": "userCollectionPlaylists", "type": "folder" }, "items": [ { "info": { "name": "Get single userCollectionPlaylist.", "type": "http" }, "http": { "method": "GET", "url": "https://openapi.tidal.com/v2/userCollectionPlaylists/:id", "params": [ { "name": "id", "value": "me", "type": "path", "description": "User collection playlists id. Use `me` for the authenticated user's resource" }, { "name": "countryCode", "value": "US", "type": "query", "description": "ISO 3166-1 alpha-2 country code" }, { "name": "locale", "value": "en-US", "type": "query", "description": "BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported." }, { "name": "include", "value": "items", "type": "query", "description": "Allows the client to customize which related resources should be returned. Available options: items, owners" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://login.tidal.com/authorize", "accessTokenUrl": "https://auth.tidal.com/v1/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves single userCollectionPlaylist by id." }, { "info": { "name": "Get items relationship (\"to-many\").", "type": "http" }, "http": { "method": "GET", "url": "https://openapi.tidal.com/v2/userCollectionPlaylists/:id/relationships/items", "params": [ { "name": "id", "value": "me", "type": "path", "description": "User collection playlists id. Use `me` for the authenticated user's resource" }, { "name": "collectionView", "value": "", "type": "query" }, { "name": "page[cursor]", "value": "", "type": "query", "description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified" }, { "name": "sort", "value": "", "type": "query", "description": "Values prefixed with \"-\" are sorted descending; values without it are sorted ascending." }, { "name": "include", "value": "items", "type": "query", "description": "Allows the client to customize which related resources should be returned. Available options: items" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://login.tidal.com/authorize", "accessTokenUrl": "https://auth.tidal.com/v1/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves items relationship." }, { "info": { "name": "Add to items relationship (\"to-many\").", "type": "http" }, "http": { "method": "POST", "url": "https://openapi.tidal.com/v2/userCollectionPlaylists/:id/relationships/items", "params": [ { "name": "id", "value": "me", "type": "path", "description": "User collection playlists id. Use `me` for the authenticated user's resource" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://login.tidal.com/authorize", "accessTokenUrl": "https://auth.tidal.com/v1/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Adds item(s) to items relationship." }, { "info": { "name": "Delete from items relationship (\"to-many\").", "type": "http" }, "http": { "method": "DELETE", "url": "https://openapi.tidal.com/v2/userCollectionPlaylists/:id/relationships/items", "params": [ { "name": "id", "value": "me", "type": "path", "description": "User collection playlists id. Use `me` for the authenticated user's resource" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://login.tidal.com/authorize", "accessTokenUrl": "https://auth.tidal.com/v1/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deletes item(s) from items relationship." }, { "info": { "name": "Get owners relationship (\"to-many\").", "type": "http" }, "http": { "method": "GET", "url": "https://openapi.tidal.com/v2/userCollectionPlaylists/:id/relationships/owners", "params": [ { "name": "id", "value": "me", "type": "path", "description": "User collection playlists id. Use `me` for the authenticated user's resource" }, { "name": "include", "value": "owners", "type": "query", "description": "Allows the client to customize which related resources should be returned. Available options: owners" }, { "name": "page[cursor]", "value": "", "type": "query", "description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://login.tidal.com/authorize", "accessTokenUrl": "https://auth.tidal.com/v1/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves owners relationship." } ] }, { "info": { "name": "userCollectionSaveForLaters", "type": "folder" }, "items": [ { "info": { "name": "Get single userCollectionSaveForLater.", "type": "http" }, "http": { "method": "GET", "url": "https://openapi.tidal.com/v2/userCollectionSaveForLaters/:id", "params": [ { "name": "id", "value": "me", "type": "path", "description": "User collection save for later id. Use `me` for the authenticated user's resource" }, { "name": "include", "value": "items", "type": "query", "description": "Allows the client to customize which related resources should be returned. Available options: items, owners" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://login.tidal.com/authorize", "accessTokenUrl": "https://auth.tidal.com/v1/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves single userCollectionSaveForLater by id." }, { "info": { "name": "Get items relationship (\"to-many\").", "type": "http" }, "http": { "method": "GET", "url": "https://openapi.tidal.com/v2/userCollectionSaveForLaters/:id/relationships/items", "params": [ { "name": "id", "value": "me", "type": "path", "description": "User collection save for later id. Use `me` for the authenticated user's resource" }, { "name": "page[cursor]", "value": "", "type": "query", "description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified" }, { "name": "countryCode", "value": "US", "type": "query", "description": "ISO 3166-1 alpha-2 country code" }, { "name": "include", "value": "items", "type": "query", "description": "Allows the client to customize which related resources should be returned. Available options: items" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://login.tidal.com/authorize", "accessTokenUrl": "https://auth.tidal.com/v1/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves items relationship." }, { "info": { "name": "Add to items relationship (\"to-many\").", "type": "http" }, "http": { "method": "POST", "url": "https://openapi.tidal.com/v2/userCollectionSaveForLaters/:id/relationships/items", "params": [ { "name": "id", "value": "me", "type": "path", "description": "User collection save for later id. Use `me` for the authenticated user's resource" }, { "name": "countryCode", "value": "US", "type": "query", "description": "ISO 3166-1 alpha-2 country code" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://login.tidal.com/authorize", "accessTokenUrl": "https://auth.tidal.com/v1/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Adds item(s) to items relationship." }, { "info": { "name": "Delete from items relationship (\"to-many\").", "type": "http" }, "http": { "method": "DELETE", "url": "https://openapi.tidal.com/v2/userCollectionSaveForLaters/:id/relationships/items", "params": [ { "name": "id", "value": "me", "type": "path", "description": "User collection save for later id. Use `me` for the authenticated user's resource" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://login.tidal.com/authorize", "accessTokenUrl": "https://auth.tidal.com/v1/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deletes item(s) from items relationship." }, { "info": { "name": "Get owners relationship (\"to-many\").", "type": "http" }, "http": { "method": "GET", "url": "https://openapi.tidal.com/v2/userCollectionSaveForLaters/:id/relationships/owners", "params": [ { "name": "id", "value": "me", "type": "path", "description": "User collection save for later id. Use `me` for the authenticated user's resource" }, { "name": "include", "value": "owners", "type": "query", "description": "Allows the client to customize which related resources should be returned. Available options: owners" }, { "name": "page[cursor]", "value": "", "type": "query", "description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://login.tidal.com/authorize", "accessTokenUrl": "https://auth.tidal.com/v1/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves owners relationship." } ] }, { "info": { "name": "userCollectionTracks", "type": "folder" }, "items": [ { "info": { "name": "Get multiple userCollectionTracks.", "type": "http" }, "http": { "method": "GET", "url": "https://openapi.tidal.com/v2/userCollectionTracks", "params": [ { "name": "countryCode", "value": "US", "type": "query", "description": "ISO 3166-1 alpha-2 country code" }, { "name": "locale", "value": "en-US", "type": "query", "description": "BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported." }, { "name": "include", "value": "items", "type": "query", "description": "Allows the client to customize which related resources should be returned. Available options: items, owners" }, { "name": "filter[id]", "value": "", "type": "query", "description": "User collection tracks id (e.g. `FMJUCzH4`)" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://login.tidal.com/authorize", "accessTokenUrl": "https://auth.tidal.com/v1/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves multiple userCollectionTracks by available filters, or without if applicable." }, { "info": { "name": "Get single userCollectionTrack.", "type": "http" }, "http": { "method": "GET", "url": "https://openapi.tidal.com/v2/userCollectionTracks/:id", "params": [ { "name": "id", "value": "me", "type": "path", "description": "User collection tracks id. Use `me` for the authenticated user's resource" }, { "name": "countryCode", "value": "US", "type": "query", "description": "ISO 3166-1 alpha-2 country code" }, { "name": "locale", "value": "en-US", "type": "query", "description": "BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported." }, { "name": "include", "value": "items", "type": "query", "description": "Allows the client to customize which related resources should be returned. Available options: items, owners" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://login.tidal.com/authorize", "accessTokenUrl": "https://auth.tidal.com/v1/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves single userCollectionTrack by id." }, { "info": { "name": "Get items relationship (\"to-many\").", "type": "http" }, "http": { "method": "GET", "url": "https://openapi.tidal.com/v2/userCollectionTracks/:id/relationships/items", "params": [ { "name": "id", "value": "me", "type": "path", "description": "User collection tracks id. Use `me` for the authenticated user's resource" }, { "name": "page[cursor]", "value": "", "type": "query", "description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified" }, { "name": "sort", "value": "", "type": "query", "description": "Values prefixed with \"-\" are sorted descending; values without it are sorted ascending." }, { "name": "countryCode", "value": "US", "type": "query", "description": "ISO 3166-1 alpha-2 country code" }, { "name": "locale", "value": "en-US", "type": "query", "description": "BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported." }, { "name": "include", "value": "items", "type": "query", "description": "Allows the client to customize which related resources should be returned. Available options: items" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://login.tidal.com/authorize", "accessTokenUrl": "https://auth.tidal.com/v1/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves items relationship." }, { "info": { "name": "Add to items relationship (\"to-many\").", "type": "http" }, "http": { "method": "POST", "url": "https://openapi.tidal.com/v2/userCollectionTracks/:id/relationships/items", "params": [ { "name": "id", "value": "me", "type": "path", "description": "User collection tracks id. Use `me` for the authenticated user's resource" }, { "name": "countryCode", "value": "US", "type": "query", "description": "ISO 3166-1 alpha-2 country code" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://login.tidal.com/authorize", "accessTokenUrl": "https://auth.tidal.com/v1/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Adds item(s) to items relationship." }, { "info": { "name": "Delete from items relationship (\"to-many\").", "type": "http" }, "http": { "method": "DELETE", "url": "https://openapi.tidal.com/v2/userCollectionTracks/:id/relationships/items", "params": [ { "name": "id", "value": "me", "type": "path", "description": "User collection tracks id. Use `me` for the authenticated user's resource" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://login.tidal.com/authorize", "accessTokenUrl": "https://auth.tidal.com/v1/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deletes item(s) from items relationship." }, { "info": { "name": "Get owners relationship (\"to-many\").", "type": "http" }, "http": { "method": "GET", "url": "https://openapi.tidal.com/v2/userCollectionTracks/:id/relationships/owners", "params": [ { "name": "id", "value": "me", "type": "path", "description": "User collection tracks id. Use `me` for the authenticated user's resource" }, { "name": "include", "value": "owners", "type": "query", "description": "Allows the client to customize which related resources should be returned. Available options: owners" }, { "name": "page[cursor]", "value": "", "type": "query", "description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://login.tidal.com/authorize", "accessTokenUrl": "https://auth.tidal.com/v1/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves owners relationship." } ] }, { "info": { "name": "userCollectionVideos", "type": "folder" }, "items": [ { "info": { "name": "Get single userCollectionVideo.", "type": "http" }, "http": { "method": "GET", "url": "https://openapi.tidal.com/v2/userCollectionVideos/:id", "params": [ { "name": "id", "value": "me", "type": "path", "description": "User collection videos id. Use `me` for the authenticated user's resource" }, { "name": "countryCode", "value": "US", "type": "query", "description": "ISO 3166-1 alpha-2 country code" }, { "name": "locale", "value": "en-US", "type": "query", "description": "BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported." }, { "name": "include", "value": "items", "type": "query", "description": "Allows the client to customize which related resources should be returned. Available options: items, owners" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://login.tidal.com/authorize", "accessTokenUrl": "https://auth.tidal.com/v1/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves single userCollectionVideo by id." }, { "info": { "name": "Get items relationship (\"to-many\").", "type": "http" }, "http": { "method": "GET", "url": "https://openapi.tidal.com/v2/userCollectionVideos/:id/relationships/items", "params": [ { "name": "id", "value": "me", "type": "path", "description": "User collection videos id. Use `me` for the authenticated user's resource" }, { "name": "page[cursor]", "value": "", "type": "query", "description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified" }, { "name": "sort", "value": "", "type": "query", "description": "Values prefixed with \"-\" are sorted descending; values without it are sorted ascending." }, { "name": "countryCode", "value": "US", "type": "query", "description": "ISO 3166-1 alpha-2 country code" }, { "name": "locale", "value": "en-US", "type": "query", "description": "BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported." }, { "name": "include", "value": "items", "type": "query", "description": "Allows the client to customize which related resources should be returned. Available options: items" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://login.tidal.com/authorize", "accessTokenUrl": "https://auth.tidal.com/v1/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves items relationship." }, { "info": { "name": "Add to items relationship (\"to-many\").", "type": "http" }, "http": { "method": "POST", "url": "https://openapi.tidal.com/v2/userCollectionVideos/:id/relationships/items", "params": [ { "name": "id", "value": "me", "type": "path", "description": "User collection videos id. Use `me` for the authenticated user's resource" }, { "name": "countryCode", "value": "US", "type": "query", "description": "ISO 3166-1 alpha-2 country code" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://login.tidal.com/authorize", "accessTokenUrl": "https://auth.tidal.com/v1/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Adds item(s) to items relationship." }, { "info": { "name": "Delete from items relationship (\"to-many\").", "type": "http" }, "http": { "method": "DELETE", "url": "https://openapi.tidal.com/v2/userCollectionVideos/:id/relationships/items", "params": [ { "name": "id", "value": "me", "type": "path", "description": "User collection videos id. Use `me` for the authenticated user's resource" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://login.tidal.com/authorize", "accessTokenUrl": "https://auth.tidal.com/v1/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deletes item(s) from items relationship." }, { "info": { "name": "Get owners relationship (\"to-many\").", "type": "http" }, "http": { "method": "GET", "url": "https://openapi.tidal.com/v2/userCollectionVideos/:id/relationships/owners", "params": [ { "name": "id", "value": "me", "type": "path", "description": "User collection videos id. Use `me` for the authenticated user's resource" }, { "name": "include", "value": "owners", "type": "query", "description": "Allows the client to customize which related resources should be returned. Available options: owners" }, { "name": "page[cursor]", "value": "", "type": "query", "description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://login.tidal.com/authorize", "accessTokenUrl": "https://auth.tidal.com/v1/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves owners relationship." } ] }, { "info": { "name": "userCollections", "type": "folder" }, "items": [ { "info": { "name": "Get single userCollection.", "type": "http" }, "http": { "method": "GET", "url": "https://openapi.tidal.com/v2/userCollections/:id", "params": [ { "name": "id", "value": "123456", "type": "path", "description": "User collection id" }, { "name": "countryCode", "value": "US", "type": "query", "description": "ISO 3166-1 alpha-2 country code" }, { "name": "locale", "value": "en-US", "type": "query", "description": "BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported." }, { "name": "include", "value": "albums", "type": "query", "description": "Allows the client to customize which related resources should be returned. Available options: albums, artists, owners, playlists, tracks, videos" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://login.tidal.com/authorize", "accessTokenUrl": "https://auth.tidal.com/v1/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deprecated. Use the dedicated collection resources instead: userCollectionAlbums, userCollectionArtists, userCollectionTracks, userCollectionVideos, or userCollectionPlaylists." }, { "info": { "name": "Get albums relationship (\"to-many\").", "type": "http" }, "http": { "method": "GET", "url": "https://openapi.tidal.com/v2/userCollections/:id/relationships/albums", "params": [ { "name": "id", "value": "123456", "type": "path", "description": "User collection id" }, { "name": "page[cursor]", "value": "", "type": "query", "description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified" }, { "name": "sort", "value": "", "type": "query", "description": "Values prefixed with \"-\" are sorted descending; values without it are sorted ascending." }, { "name": "countryCode", "value": "US", "type": "query", "description": "ISO 3166-1 alpha-2 country code" }, { "name": "locale", "value": "en-US", "type": "query", "description": "BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported." }, { "name": "include", "value": "albums", "type": "query", "description": "Allows the client to customize which related resources should be returned. Available options: albums" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://login.tidal.com/authorize", "accessTokenUrl": "https://auth.tidal.com/v1/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deprecated. Use the userCollectionAlbums resource and its items relationship instead." }, { "info": { "name": "Add to albums relationship (\"to-many\").", "type": "http" }, "http": { "method": "POST", "url": "https://openapi.tidal.com/v2/userCollections/:id/relationships/albums", "params": [ { "name": "id", "value": "123456", "type": "path", "description": "User collection id" }, { "name": "countryCode", "value": "US", "type": "query", "description": "ISO 3166-1 alpha-2 country code" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://login.tidal.com/authorize", "accessTokenUrl": "https://auth.tidal.com/v1/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deprecated. Use the userCollectionAlbums resource and its items relationship instead." }, { "info": { "name": "Delete from albums relationship (\"to-many\").", "type": "http" }, "http": { "method": "DELETE", "url": "https://openapi.tidal.com/v2/userCollections/:id/relationships/albums", "params": [ { "name": "id", "value": "123456", "type": "path", "description": "User collection id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://login.tidal.com/authorize", "accessTokenUrl": "https://auth.tidal.com/v1/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deprecated. Use the userCollectionAlbums resource and its items relationship instead." }, { "info": { "name": "Get artists relationship (\"to-many\").", "type": "http" }, "http": { "method": "GET", "url": "https://openapi.tidal.com/v2/userCollections/:id/relationships/artists", "params": [ { "name": "id", "value": "123456", "type": "path", "description": "User collection id" }, { "name": "page[cursor]", "value": "", "type": "query", "description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified" }, { "name": "sort", "value": "", "type": "query", "description": "Values prefixed with \"-\" are sorted descending; values without it are sorted ascending." }, { "name": "countryCode", "value": "US", "type": "query", "description": "ISO 3166-1 alpha-2 country code" }, { "name": "locale", "value": "en-US", "type": "query", "description": "BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported." }, { "name": "include", "value": "artists", "type": "query", "description": "Allows the client to customize which related resources should be returned. Available options: artists" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://login.tidal.com/authorize", "accessTokenUrl": "https://auth.tidal.com/v1/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deprecated. Use the userCollectionArtists resource and its items relationship instead." }, { "info": { "name": "Add to artists relationship (\"to-many\").", "type": "http" }, "http": { "method": "POST", "url": "https://openapi.tidal.com/v2/userCollections/:id/relationships/artists", "params": [ { "name": "id", "value": "123456", "type": "path", "description": "User collection id" }, { "name": "countryCode", "value": "US", "type": "query", "description": "ISO 3166-1 alpha-2 country code" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://login.tidal.com/authorize", "accessTokenUrl": "https://auth.tidal.com/v1/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deprecated. Use the userCollectionArtists resource and its items relationship instead." }, { "info": { "name": "Delete from artists relationship (\"to-many\").", "type": "http" }, "http": { "method": "DELETE", "url": "https://openapi.tidal.com/v2/userCollections/:id/relationships/artists", "params": [ { "name": "id", "value": "123456", "type": "path", "description": "User collection id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://login.tidal.com/authorize", "accessTokenUrl": "https://auth.tidal.com/v1/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deprecated. Use the userCollectionArtists resource and its items relationship instead." }, { "info": { "name": "Get owners relationship (\"to-many\").", "type": "http" }, "http": { "method": "GET", "url": "https://openapi.tidal.com/v2/userCollections/:id/relationships/owners", "params": [ { "name": "id", "value": "123456", "type": "path", "description": "User collection id" }, { "name": "include", "value": "owners", "type": "query", "description": "Allows the client to customize which related resources should be returned. Available options: owners" }, { "name": "page[cursor]", "value": "", "type": "query", "description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://login.tidal.com/authorize", "accessTokenUrl": "https://auth.tidal.com/v1/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves owners relationship." }, { "info": { "name": "Get playlists relationship (\"to-many\").", "type": "http" }, "http": { "method": "GET", "url": "https://openapi.tidal.com/v2/userCollections/:id/relationships/playlists", "params": [ { "name": "id", "value": "123456", "type": "path", "description": "User collection id" }, { "name": "collectionView", "value": "", "type": "query" }, { "name": "page[cursor]", "value": "", "type": "query", "description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified" }, { "name": "sort", "value": "", "type": "query", "description": "Values prefixed with \"-\" are sorted descending; values without it are sorted ascending." }, { "name": "include", "value": "playlists", "type": "query", "description": "Allows the client to customize which related resources should be returned. Available options: playlists" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://login.tidal.com/authorize", "accessTokenUrl": "https://auth.tidal.com/v1/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deprecated. Use the userCollectionPlaylists resource and its items relationship instead." }, { "info": { "name": "Add to playlists relationship (\"to-many\").", "type": "http" }, "http": { "method": "POST", "url": "https://openapi.tidal.com/v2/userCollections/:id/relationships/playlists", "params": [ { "name": "id", "value": "123456", "type": "path", "description": "User collection id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://login.tidal.com/authorize", "accessTokenUrl": "https://auth.tidal.com/v1/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deprecated. Use the userCollectionPlaylists resource and its items relationship instead." }, { "info": { "name": "Delete from playlists relationship (\"to-many\").", "type": "http" }, "http": { "method": "DELETE", "url": "https://openapi.tidal.com/v2/userCollections/:id/relationships/playlists", "params": [ { "name": "id", "value": "123456", "type": "path", "description": "User collection id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://login.tidal.com/authorize", "accessTokenUrl": "https://auth.tidal.com/v1/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deprecated. Use the userCollectionPlaylists resource and its items relationship instead." }, { "info": { "name": "Get tracks relationship (\"to-many\").", "type": "http" }, "http": { "method": "GET", "url": "https://openapi.tidal.com/v2/userCollections/:id/relationships/tracks", "params": [ { "name": "id", "value": "123456", "type": "path", "description": "User collection id" }, { "name": "page[cursor]", "value": "", "type": "query", "description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified" }, { "name": "sort", "value": "", "type": "query", "description": "Values prefixed with \"-\" are sorted descending; values without it are sorted ascending." }, { "name": "countryCode", "value": "US", "type": "query", "description": "ISO 3166-1 alpha-2 country code" }, { "name": "locale", "value": "en-US", "type": "query", "description": "BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported." }, { "name": "include", "value": "tracks", "type": "query", "description": "Allows the client to customize which related resources should be returned. Available options: tracks" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://login.tidal.com/authorize", "accessTokenUrl": "https://auth.tidal.com/v1/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deprecated. Use the userCollectionTracks resource and its items relationship instead." }, { "info": { "name": "Add to tracks relationship (\"to-many\").", "type": "http" }, "http": { "method": "POST", "url": "https://openapi.tidal.com/v2/userCollections/:id/relationships/tracks", "params": [ { "name": "id", "value": "123456", "type": "path", "description": "User collection id" }, { "name": "countryCode", "value": "US", "type": "query", "description": "ISO 3166-1 alpha-2 country code" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://login.tidal.com/authorize", "accessTokenUrl": "https://auth.tidal.com/v1/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deprecated. Use the userCollectionTracks resource and its items relationship instead." }, { "info": { "name": "Delete from tracks relationship (\"to-many\").", "type": "http" }, "http": { "method": "DELETE", "url": "https://openapi.tidal.com/v2/userCollections/:id/relationships/tracks", "params": [ { "name": "id", "value": "123456", "type": "path", "description": "User collection id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://login.tidal.com/authorize", "accessTokenUrl": "https://auth.tidal.com/v1/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deprecated. Use the userCollectionTracks resource and its items relationship instead." }, { "info": { "name": "Get videos relationship (\"to-many\").", "type": "http" }, "http": { "method": "GET", "url": "https://openapi.tidal.com/v2/userCollections/:id/relationships/videos", "params": [ { "name": "id", "value": "123456", "type": "path", "description": "User collection id" }, { "name": "page[cursor]", "value": "", "type": "query", "description": "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified" }, { "name": "sort", "value": "", "type": "query", "description": "Values prefixed with \"-\" are sorted descending; values without it are sorted ascending." }, { "name": "countryCode", "value": "US", "type": "query", "description": "ISO 3166-1 alpha-2 country code" }, { "name": "locale", "value": "en-US", "type": "query", "description": "BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported." }, { "name": "include", "value": "videos", "type": "query", "description": "Allows the client to customize which related resources should be returned. Available options: videos" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://login.tidal.com/authorize", "accessTokenUrl": "https://auth.tidal.com/v1/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deprecated. Use the userCollectionVideos resource and its items relationship instead." }, { "info": { "name": "Add to videos relationship (\"to-many\").", "type": "http" }, "http": { "method": "POST", "url": "https://openapi.tidal.com/v2/userCollections/:id/relationships/videos", "params": [ { "name": "id", "value": "123456", "type": "path", "description": "User collection id" }, { "name": "countryCode", "value": "US", "type": "query", "description": "ISO 3166-1 alpha-2 country code" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://login.tidal.com/authorize", "accessTokenUrl": "https://auth.tidal.com/v1/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deprecated. Use the userCollectionVideos resource and its items relationship instead." }, { "info": { "name": "Delete from videos relationship (\"to-many\").", "type": "http" }, "http": { "method": "DELETE", "url": "https://openapi.tidal.com/v2/userCollections/:id/relationships/videos", "params": [ { "name": "id", "value": "123456", "type": "path", "description": "User collection id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://login.tidal.com/authorize", "accessTokenUrl": "https://auth.tidal.com/v1/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deprecated. Use the userCollectionVideos resource and its items relationship instead." } ] } ], "bundled": true }