Skip to main content
GET
/
sync
/
playback
/
{type}
Get paused playback sessions for one type
curl --request GET \
  --url 'https://api.simkl.com/sync/playback/{type}?client_id=' \
  --header 'Authorization: Bearer <token>' \
  --header 'User-Agent: <user-agent>'
[
  {
    "id": 123,
    "progress": 45.5,
    "paused_at": "2024-01-15T10:30:00.000Z",
    "type": "episode",
    "episode": {
      "season": 1,
      "episode": 5,
      "title": "Episode 5",
      "tvdb_season": 1,
      "tvdb_number": 5
    },
    "show": {
      "title": "Breaking Bad",
      "year": 2008,
      "ids": {
        "simkl": 12345,
        "slug": "breaking-bad",
        "tmdb": 1429,
        "imdb": "tt0903747"
      }
    }
  },
  {
    "id": 124,
    "progress": 75,
    "paused_at": "2024-01-15T11:15:00.000Z",
    "type": "movie",
    "movie": {
      "title": "Inception",
      "year": 2010,
      "ids": {
        "simkl": 67890,
        "slug": "inception",
        "tmdb": 27205,
        "imdb": "tt1375666"
      }
    }
  }
]

Documentation Index

Fetch the complete documentation index at: https://api.simkl.org/llms.txt

Use this file to discover all available pages before exploring further.

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

OAuth 2.0 or PIN-flow access_token. Required for endpoints that read or modify the user's library, scrobble session, ratings, settings, or playbacks. See 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).

Path Parameters

​
type
enum<string>
required

episodes or movies to filter by item type. To get all paused playbacks of both kinds, call GET /sync/playback. Strictness; drop the segment from the URL to call without it.

Available options:
movies,
episodes

Query Parameters

​
limit
number

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

​
hide_watched
enum<string>
default:true

When true, hides items already watched after the pause was created.

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.