Filters are used to refine your search results when working with the playlist object. This page provides the complete list of supported playlist filters.
API v2 now availableVisit the API v2 documentation or follow the migration guide to upgrade.
| Fields | Description |
|---|---|
ids | Limit the result set to this list of playlist identifiers (works only with xIDs). |
limit | Limits the number of results per page. Max: 100 |
owner | Limit the result set to playlists of this user. |
page | The page number to load. Allows to navigate from one page to the other when the results are on several pages. Max: 10 if limit=100Depends if has_more at the top of the page is true or false |
private | Limit the result set to private playlists. |
search | Limit the result set to this full text search. |
sort | Change the default result set ordering. |
verified | Limit the result set to verified partner playlists. |
ids
idsLimit the result set to this list of playlist identifiers (works only with xIDs).
Min length: 1 / Max length: 150
| Type | Sample value |
|---|---|
| array of strings | [xk2k3, x26m1j4, xkeg4] |
limit
limitLimits the number of results per page.
Max: 100
| Type | Sample value |
|---|---|
| number | 50 |
owner
ownerLimit the result set to playlists of this user.
| Type | Sample value |
|---|---|
| string | x43py0 |
page
pageThe page number to load. Allows to navigate from one page to the other when the results are on several pages.
Max: 10 if limit=100
Depends if has_more at the top of the page is true or false
| Type | Sample value |
|---|---|
| number | 1 |
private
privateLimit the result set to private playlists.
| Type | Sample value |
|---|---|
| boolean | true |
search
searchLimit the result set to this full text search.
Min length: 1 / Max length: 150
| Type | Sample value |
|---|---|
| string | football |
sort
sortChange the default result set ordering.
Possible values:
-
recent -
relevance -
alpha -
most -
least -
alphaaz -
alphaza -
changed
| Type | Sample value |
|---|---|
| string | recent |
verified
verifiedLimit the result set to verified partner playlists.
| Type | Sample value |
|---|---|
| flag | N/A |