Skip to main content

Smartlist Browse

Smartlist Browse

This page lists the filters and sorts the smartplaylist browse accepts. Refer to the main Api Browse methods page for how to send them.

NOTE Smartlists are saved searches (the search table), so this browse can sort on the search's own limit and random settings.

NOTE A saved smartlist loaded by id is always a song search; the object type it was built for is not stored.

API methods using this browse

smartlists, user_smartlists

Available browse filters

Send filters in the cond parameter as filter,value pairs, separated by ;

e.g. cond=starts_with,a

FilterValueDescription
alpha_matchstringAlias of like.
equalstringThe smartlist name is exactly this value. Matching is case insensitive.
exact_matchstringAlias of equal.
idarrayOnly these smartlist ids. It takes a list, which cond cannot send, so cond=id,1 builds an empty list and the browse returns nothing.
likestringThe smartlist name contains this value.
not_likestringThe smartlist name does not contain this value.
not_starts_withstringThe smartlist name does not start with this value.
playlist_openuser idOnly lists this user can open: public ones, their own, ones they collaborate on and ones shared with them.
playlist_type0 or 1Send 0 for lists owned by the current user, 1 for every list they can open. Sending it twice toggles it.
playlist_useruser idOnly lists owned by this user.
regex_matchregexThe smartlist name matches this MySQL regular expression. Setting it clears any regex_not_match filter.
regex_not_matchregexThe smartlist name does not match this MySQL regular expression. Setting it clears any regex_match filter.
starts_withstringThe smartlist name starts with this value.
user_flag0 or 1Send 1 for smartlists the current user has favourited, 0 for the ones they have not.
user_rating0 to 5Only smartlists the current user rated this value. Send 0 for smartlists they have not rated at all.

Available browse sorts

Send a single sort in the sort parameter as name,order, where order is ASC or DESC.

e.g. sort=name,DESC

SortDescription
dateWhen the smartlist was created.
idThe smartlist id, which is the order they were created in.
last_countHow many items the smartlist returned when it was last counted.
last_updateWhen it was last updated.
limitThe row limit saved on the smartlist.
nameSmartlist name, then id, so smartlists with the same name keep a stable order.
randRandom order, applied per request. Paging through it repeats and skips smartlists, so ask for everything in one call.
randomWhether the smartlist returns its rows randomly.
ratingYour own rating, then when you set it. Smartlists you have not rated group together.
titleAlias of name.
typeVisibility: public or private.
userThe id of the user who owns it.
user_flagWhen you added it to your favourites. This is a date, not a flag, so everything you have not favourited groups together.
user_flag_ratingWhen you added it to your favourites, then your rating.
userflagAlias of user_flag.
usernameThe owner's username.