Playlists Public

Retrieve all playlists

Query parameters must conform to the GetPlaylistsRequestPayload schema.

get/playlists

Request

  • Base URL: https://musicfun.it-incubator.app/api/1.0
  • URL: https://musicfun.it-incubator.app/api/1.0/playlists
  • Auth: API key in header api-key

Query parameters

pageNumbernumber

Page number for pagination (starting from 1)

pageSizenumber

Page size for pagination (between 0 and 20)

searchstring

Search term for filtering playlists by name

sortBy'addedAt' | 'likesCount'

Field by which to sort playlists

sortDirection'asc' | 'desc'

Sort direction (ascending or descending)

tagsIdsstring[]

Filter by tag IDs. Multiple values allowed, e.g.: tagsIds=tag1&tagsIds=tag2

userIdstring

Filter by user ID (playlist creator’s ID)

trackIdstring

Filter by track ID – only playlists containing this track will be returned

onlyLikedByMeboolean

If true, return only playlists liked by the current authenticated user

Response

OK: JSON:API list of playlists with pagination

Example response

{
  "data": [
    {
      "type": "playlists"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.