Skip to main content
GET
Get paused playback sessions for every type

Authorizations

client_id
string
query
default:YOUR_CLIENT_ID
required

Preferred form: your client_id as a URL query parameter on every request. Self-describing in logs and curl commands. See Headers and required parameters.

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.

Headers

User-Agent
string
required

Descriptive identifier for your app, ideally name/version. Examples: PlexMediaServer/1.43.1.10540, kodi-simkl/0.9.2, MyApp/2.4.1 (https://myapp.com).

Query Parameters

limit
number

Slice your result to the first N items. Default: 10000

hide_watched
enum<string>
default:true

Controls whether playbacks for items the user has already finished are filtered out.

true (default) hides a paused playback only when the item was watched at or after the moment it was paused — a stale leftover, e.g. the user paused at 40% and then marked the whole thing watched from another app.

It does not hide a playback that was paused after the item was finished. That is a re-viewing in progress, and it is returned even with hide_watched=true. A user who finished a film years ago and is 45% into watching it again gets that playback back in the list, which is what a Continue Watching row should show.

false skips the check entirely, including the stale-leftover case.

One edge case: for items whose watch date is the "watched, date unknown" placeholder there is no date to compare, so true falls back to hiding completed movies and the specific episode the watchlist last pointed at.

Available options:
true,
false
date_from
string

Filter sessions from this date

date_to
string

Filter sessions until this date

client_id
string
required

Your client_id from your Simkl developer settings. Required on every request.

app-name
string
required

Short, lowercase identifier for your app (e.g. plex-scrobbler, kodi-bridge). Helps Simkl identify which apps are using the API.

app-version
string
required

Your app's current version (e.g. 1.0, 2.4.1). Helps Simkl debug issues you report.

Response

OK

id
integer

Internal playback session ID. Use to delete via DELETE /sync/playback/{id}.

progress
number

Saved progress percentage 0–100.

watched_at
string<date-time>
movie
object

Standard movie object. See the Standard Media Objects guide.

show
object

Standard show object. May include nested seasons/episodes for partial sync.

anime
object

Standard anime object. Like Show, but may include anime_type. Episode numbering follows AniDB.

episode
object

Episode reference. Use season + number, or ids.