Pulsarr

List watchlist items with their exclusion state

GET
/v1/watchlist-exclusions/items

Page through watchlisted and excluded titles, one row per title with its watchlisters and own exclusions attached

Authorization

headerX-API-Key<token>

API key authentication using X-API-Key header

Query Parameters

search?string
userId?number
type?string

Media kind, movie or show

Value in"movie""show"
status?string

Routing state of a watchlist item or one of its instance rows: pending (not routed), requested (sent to the arr, no file), grabbed (the arr has the file), notified (in Plex and the user was told)

Value in"pending""requested""grabbed""notified"
exclusion?string

excluded has a global or at least one own exclusion, not-excluded has neither, orphan has no watchlister left

Value in"excluded""not-excluded""orphan"
limit?integer
Range1 <= value <= 1000
Default20
offset?integer
Range0 <= value <= 9007199254740991
Default0
sortBy?string
Default"excludedAt"
Value in"title""watchlisters""excluded""excludedAt"
sortOrder?string

Sort direction, asc for ascending and desc for descending

Default"desc"
Value in"asc""desc"

Response Body

Default Response

application/json
  1. response

One page of watchlist items with their exclusion state

success*boolean
message*string
items*array<>
total*number
limit*number
offset*number
Example Request
curl -X GET 'http://localhost:3003/v1/watchlist-exclusions/items'
Example Response
{  "success": true,  "message": "string",  "items": [    {      "key": "string",      "title": "string",      "type": "movie",      "guids": [        "string"      ],      "thumb": "string",      "globalExclusion": {        "id": 0,        "excludedAt": "string"      },      "watchlisterCount": 0,      "excludedCount": 0,      "users": [        {          "userId": 0,          "userName": "string",          "status": "pending",          "added": "string",          "ownExclusion": {            "id": 0,            "excludedAt": "string"          }        }      ]    }  ],  "total": 0,  "limit": 0,  "offset": 0}