Skip to main content
GET
Get a user's custom lists

Authorizations

Authorization
string
header
default:YOUR_ACCESS_TOKEN
required

A user access_token, sent as Authorization: Bearer .... Required for endpoints that read or modify the user's library, scrobble session, ratings, settings, or playbacks. Every flow returns the same kind of token. See Set up authentication.

Path Parameters

userId
integer
required

Numeric Simkl user ID.

Query Parameters

limit
integer
default:50

Items per page, 1 to 500. Values outside that range are clamped silently rather than rejected, so asking for 99999 returns 500 and a 200.

A non-numeric value is normally 400 wrong_parameter, but on GET /lists/{id} that is not guaranteed: the edge cache coerces this parameter itself, so on a cache hit a malformed value is silently replaced with the default and answered 200. Validate paging input on your side rather than relying on a 400.

Required range: 1 <= x <= 500
page
integer
default:1

1-based page number, also clamped silently. page times limit cannot exceed 10000, so deep paging is capped -- at the default limit of 50 the last reachable page is 200.

As with limit, a non-numeric value is normally 400 but can be silently defaulted on a cached GET /lists/{id} response.

Required range: x >= 1
direction
enum<string>

Sort direction. Anything other than asc or desc is a 400.

Available options:
asc,
desc
sort
enum<string>
default:updated

Ordering. Anything outside this set is a 400.

Available options:
updated,
created,
name,
likes,
followers,
items,
popularity
followed
enum<string>

Set to the literal string true to include lists the user follows. 1, yes and on do nothing.

Available options:
true
collaborants
enum<string>

Set to the literal string true to include lists the user collaborates on. Only meaningful when viewing your own account.

Available options:
true

Response

The user's lists. This route has no PRO or VIP gate -- unlike GET /lists/{id}, an anonymous caller gets the real payload.

Pagination plus the lists array.

pagination
object
required
lists
object[]
required

One entry per list. Reading your own library adds a pinned flag to every entry, including followed and collaborated ones.