Introduction
This is the documentation for the Seerr API backend.
Add a new slider
Add a single slider and return the newly created slider. Requires the `ADMIN` permission.
Add collection to blocklist
Adds all movies in a collection to the blocklist
Add media to blocklist
Add media to blocklist
Add media to watchlist
Add media to watchlist
Batch update all sliders.
Batch update all sliders at once. Should also be used for creation. Will only update sliders provided
Cancel a specific job
Cancels a specific job. Will return the new job status in JSON format.
Create a comment
Creates a comment and returns associated issue in JSON format.
Create new issue
Creates a new issue
Create new request
Creates a new request with the provided media ID and type. The `REQUEST` permission is required.
Create new user
Creates a new user. Requires the `MANAGE_USERS` permission.
Create override rule
Creates a new Override Rule from the request body.
Create Radarr instance
Creates a new Radarr instance from the request body.
Create Sonarr instance
Creates a new Sonarr instance from the request body.
Delete issue comment
Deletes an issue comment. Only users with `MANAGE_ISSUES` or the user who created the comment can perform this action.
Delete issue
Removes an issue. If the user has the `MANAGE_ISSUES` permission, any issue can be removed. Otherwise, only a users own issues can be removed.
Delete media file
Removes a media file from radarr/sonarr. The `ADMIN` permission is required to perform this action.
Delete media item
Removes a media item. The `MANAGE_REQUESTS` permission is required to perform this action.
Delete override rule by ID
Deletes the override rule with the provided ruleId.
Delete Radarr instance
Deletes an existing Radarr instance based on the radarrId parameter.
Delete request
Removes a request. If the user has the `MANAGE_REQUESTS` permission, any request can be removed. Otherwise, only pending requests can be removed.
Delete slider by ID
Deletes the slider with the provided sliderId. Requires the `ADMIN` permission.
Delete Sonarr instance
Deletes an existing Sonarr instance based on the sonarrId parameter.
Delete user by ID
Deletes the user with the provided userId. Requires the `MANAGE_USERS` permission.
Delete user push subscription by key
Deletes the user push subscription with the provided key.
Delete watchlist item
Removes a watchlist item.
Discover movies by genre
Returns a list of movies based on the provided genre ID in a JSON object.
Discover movies by original language
Returns a list of movies based on the provided ISO 639-1 language code in a JSON object.
Discover movies by studio
Returns a list of movies based on the provided studio ID in a JSON object.
Discover movies
Returns a list of movies in a JSON object.
Discover TV shows by genre
Returns a list of TV shows based on the provided genre ID in a JSON object.
Discover TV shows by network
Returns a list of TV shows based on the provided network ID in a JSON object.
Discover TV shows by original language
Returns a list of TV shows based on the provided ISO 639-1 language code in a JSON object.
Discover TV shows
Returns a list of TV shows in a JSON object.
Discover Upcoming TV shows
Returns a list of upcoming TV shows in a JSON object.
Flush a specific cache
Flushes all data from the cache ID provided
Flush a specific DNS cache entry
Flushes a specific DNS cache entry
Get a list of active caches
Retrieves a list of all active caches and their current stats.
Get all discover sliders
Returns all discovery sliders. Built-in and custom made.
Get all issues
Returns a list of issues in JSON format.
Get all requests
Returns all requests if the user has the `ADMIN` or `MANAGE_REQUESTS` permissions. Otherwise, only the logged-in user's requests are returned.
Get all users
Returns all users in a JSON object.
Get all web push notification settings for a user
Returns all web push notification settings for a user in a JSON object.
Get application data volume status
For Docker installs, returns whether or not the volume mount was configured properly. Always returns true for non-Docker installs.
Get available Radarr profiles
Returns a list of profiles available on the Radarr server instance in a JSON array.
Get backdrops of trending items
Returns a list of backdrop image paths in a JSON array.
Get collection details
Returns full collection details in a JSON object.
Get combined credits
Returns the person's combined credits based on the provided personId in a JSON object.
Get Discord notification settings
Returns current Discord notification settings in a JSON object.
Get email notification settings
Returns current email notification settings in a JSON object.
Get general settings for a user
Returns general settings for a specific user. Requires `MANAGE_USERS` permission if viewing other users.
Get genre slider data for movies
Returns a list of genres with backdrops attached
Get genre slider data for TV series
Returns a list of genres with backdrops attached
Get Gotify notification settings
Returns current Gotify notification settings in a JSON object.
Get issue comment
Returns a single issue comment in JSON format.
Get issue
Returns a single issue in JSON format.
Get Jellyfin libraries
Returns a list of Jellyfin libraries in a JSON array.
Get Jellyfin settings
Retrieves current Jellyfin settings.
Get Jellyfin Users
Returns a list of Jellyfin Users in a JSON array.
Get keyword
Returns a single keyword in JSON format.
Get list of official TMDB movie genres
Returns a list of genres in a JSON array.
Get logged-in user
Returns the currently logged-in user.
Get main settings with newly-generated API key
Returns main settings in a JSON object, using the new API key.
Get main settings
Retrieves all main settings in a JSON object.
Get media from blocklist
Get media from blocklist
Get MediaRequest
Returns a specific MediaRequest in a JSON object.
Get media
Returns all media (can be filtered and limited) in a JSON object.
Get Metadata settings
Retrieves current Metadata settings.
Get movie certifications
Returns list of movie certifications from TMDB.
Get movie details
Returns full movie details in a JSON object.
Get movie ratings
Returns ratings based on the provided movieId in a JSON object.
Get movie studio details
Returns movie studio details in a JSON object.
Get movies from keyword
Returns list of movies based on the provided keyword ID a JSON object.
Get network settings
Retrieves all network settings in a JSON object.
Get non-sensitive Radarr server list
Returns a list of Radarr server IDs and names in a JSON object.
Get non-sensitive Sonarr server list
Returns a list of Sonarr server IDs and names in a JSON object.
Get notification settings for a user
Returns notification settings for a specific user. Requires `MANAGE_USERS` permission if viewing other users.
Get ntfy.sh notification settings
Returns current ntfy.sh notification settings in a JSON object.
Get override rules
Returns a list of all override rules with their conditions and settings
Get password page informatiom
Returns important data for the password page to function correctly. Requires `MANAGE_USERS` permission if viewing other users.
Get permission settings for a user
Returns permission settings for a specific user. Requires `MANAGE_USERS` permission if viewing other users.
Get person details
Returns person details based on provided personId in a JSON object.
Get Plex libraries
Returns a list of Plex libraries in a JSON array.
Get Plex settings
Retrieves current Plex settings.
Get Plex users
Returns a list of Plex users in a JSON array.
Get public settings
Returns settings that are not protected or sensitive. Mainly used to determine if the application has been configured for the first time.
Get Pushbullet notification settings
Returns current Pushbullet notification settings in a JSON object.
Get Pushover notification settings
Returns current Pushover notification settings in a JSON object.
Get Pushover sounds
Returns valid Pushover sound options in a JSON array.
Get quotas for a specific user
Returns quota details for a user in a JSON object. Requires `MANAGE_USERS` permission if viewing other users.
Get Radarr server quality profiles and root folders
Returns a Radarr server's quality profile and root folder details in a JSON object.
Get Radarr settings
Returns all Radarr settings in a JSON array.
Get recommended movies
Returns list of recommended movies based on provided movie ID in a JSON object.
Get recommended TV series
Returns list of recommended TV series based on the provided tvId in a JSON object.
Get requests for a specific user
Retrieves a user's requests in a JSON object.
Get RT and IMDB movie ratings combined
Returns ratings from RottenTomatoes and IMDB based on the provided movieId in a JSON object.
Get scheduled jobs
Returns list of all scheduled jobs and details about their next execution time in a JSON array.
Get season details and episode list
Returns season details with a list of episodes in a JSON object.
Get Seerr status
Returns the current Seerr status in a JSON object.
Get series from Sonarr
Returns a list of series returned by searching for the name in Sonarr.
Get server stats
Returns current server stats in a JSON object.
Get similar movies
Returns list of similar movies based on the provided movieId in a JSON object.
Get similar TV series
Returns list of similar TV series based on the provided tvId in a JSON object.
Get Slack notification settings
Returns current Slack notification settings in a JSON object.
Get Sonarr server quality profiles and root folders
Returns a Sonarr server's quality profile and root folder details in a JSON object.
Get Sonarr settings
Returns all Sonarr settings in a JSON array.
Get status of full Jellyfin library sync
Returns sync progress in a JSON array.
Get status of full Plex library scan
Returns scan progress in a JSON array.
Get Tautulli settings
Retrieves current Tautulli settings.
Get Telegram notification settings
Returns current Telegram notification settings in a JSON object.
Get the Plex watchlist for a specific user
Retrieves a user's Plex Watchlist in a JSON object.
Get the Plex watchlist.
Get the Plex watchlist.
Get TV certifications
Returns list of TV show certifications from TMDB.
Get TV details
Returns full TV details in a JSON object.
Get TV network details
Returns TV network details in a JSON object.
Get TV ratings
Returns ratings based on provided tvId in a JSON object.
Get user by ID
Retrieves user details in a JSON object. Requires the `MANAGE_USERS` permission.
Get user by Jellyfin user ID
Retrieves user details by Jellyfin user ID in a JSON object. Returns filtered data based on the caller's permissions.
Get watch data
Returns play count, play duration, and recently watched media.
Get watch provider movies
Returns a list of all available watch providers for movies.
Get watch provider regions
Returns a list of all available watch provider regions.
Get watch provider series
Returns a list of all available watch providers for series.
Get web push notification settings for a user
Returns web push notification settings for a user in a JSON object.
Get Web Push notification settings
Returns current Web Push notification settings in a JSON object.
Get webhook notification settings
Returns current webhook notification settings in a JSON object.
Gets issue counts
Returns the number of open and closed issues, as well as the number of issues of each type.
Gets request counts
Returns the number of requests by status including pending, approved, available, and completed requests.
Gets the user's available Plex servers
Returns a list of available Plex servers and their connectivity state
Import all users from Jellyfin
Fetches and imports users from the Jellyfin server.
Import all users from Plex
Fetches and imports users from the Plex server. If a list of Plex IDs is provided in the request body, only the specified users will be imported. Otherwise, all users will be imported.
Initialize application
Sets the app as initialized, allowing the user to navigate to pages other than the setup page.
Invoke a specific job
Invokes a specific job to run. Will return the new job status in JSON format.
Languages supported by TMDB
Returns a list of languages in a JSON object.
Link the provided Jellyfin account to the current user
Logs in to Jellyfin with the provided credentials, then links the associated Jellyfin account with the user's account. Users can only link external accounts to their own account.
Link the provided Plex account to the current user
Logs in to Plex with the provided auth token, then links the associated Plex account with the user's account. Users can only link external accounts to their own account.
Modify job schedule
Re-registers the job with the schedule specified. Will return the job in JSON format.
Regions supported by TMDB
Returns a list of regions in a JSON object.
Register a web push /user/registerPushSubscription
Registers a web push subscription for the logged-in user
Remove collection from blocklist
Removes all movies in a collection from the blocklist
Remove media from blocklist
Remove media from blocklist
Remove the linked Jellyfin account for a user
Removes the linked Jellyfin account for a specific user. Requires `MANAGE_USERS` permission if editing other users.
Remove the linked Plex account for a user
Removes the linked Plex account for a specific user. Requires `MANAGE_USERS` permission if editing other users.
Reset all discover sliders
Resets all discovery sliders to the default values. Requires the `ADMIN` permission.
Reset the password for a user
Resets the password for a user if the given guid is connected to a user
Retry failed request
Retries a request by resending requests to Sonarr or Radarr.
Returns blocklisted items
Returns list of all blocklisted media
Returns logs
Returns list of all log items and details
Search for companies
Returns a list of TMDB companies matching the search query. (Will not return origin country)
Search for keywords
Returns a list of TMDB keywords matching the search query
Search for movies, TV shows, or people
Returns a list of movies, TV shows, or people a JSON object.
Send a reset password email
Sends a reset password email to the email if the user exists
Sign in using a Jellyfin username and password
Takes the user's username and password to log the user in. Generates a session cookie for use in further requests. If the user does not exist, and there are no other users, then a user will be created with full admin privileges. If a user logs in with access to the Jellyfin server, they will also have an account created, but without any permissions.
Sign in using a local account
Takes an `email` and a `password` to log the user in. Generates a session cookie for use in further requests.
Sign in using a Plex token
Takes an `authToken` (Plex token) to log the user in. Generates a session cookie for use in further requests. If the user does not exist, and there are no other users, then a user will be created with full admin privileges. If a user logs in with access to the main Plex server, they will also have an account created, but without any permissions.
Sign out and clear session cookie
Completely clear the session cookie and associated values, effectively signing the user out.
Start full Jellyfin library sync
Runs a full Jellyfin library sync and returns the progress in a JSON array.
Start full Plex library scan
Runs a full Plex library scan and returns the progress in a JSON array.
Test Discord settings
Sends a test notification to the Discord agent.
Test email settings
Sends a test notification to the email agent.
Test Gotify settings
Sends a test notification to the Gotify agent.
Test ntfy.sh settings
Sends a test notification to the ntfy.sh agent.
Test Provider configuration
Tests if the TVDB configuration is valid. Returns a list of available languages on success.
Test Pushbullet settings
Sends a test notification to the Pushbullet agent.
Test Pushover settings
Sends a test notification to the Pushover agent.
Test Radarr configuration
Tests if the Radarr configuration is valid. Returns profiles and root folders on success.
Test Slack settings
Sends a test notification to the Slack agent.
Test Sonarr configuration
Tests if the Sonarr configuration is valid. Returns profiles and root folders on success.
Test Telegram settings
Sends a test notification to the Telegram agent.
Test Web Push settings
Sends a test notification to the Web Push agent.
Test webhook settings
Sends a test notification to the webhook agent.
Trending movies and TV
Returns a list of movies and TV shows in a JSON object.
Upcoming movies
Returns a list of movies in a JSON object.
Update a request's status
Updates a request's status to approved or declined. Also returns the request in a JSON object.
Update a single slider
Updates a single slider and return the newly updated slider. Requires the `ADMIN` permission.
Update a user by user ID
Update a user with the provided values. You cannot update a user's Plex token through this request.
Update an issue's status
Updates an issue's status to approved or declined. Also returns the issue in a JSON object.
Update batch of users
Update users with given IDs with provided values in request `body.settings`. You cannot update users' Plex tokens through this request.
Update Discord notification settings
Updates Discord notification settings with the provided values.
Update email notification settings
Updates email notification settings with provided values
Update general settings for a user
Updates and returns general settings for a specific user. Requires `MANAGE_USERS` permission if editing other users.
Update Gotify notification settings
Update Gotify notification settings with the provided values.
Update issue comment
Updates and returns a single issue comment in JSON format.
Update Jellyfin settings
Updates Jellyfin settings with the provided values.
Update main settings
Updates main settings with the provided values.
Update MediaRequest
Updates a specific media request and returns the request in a JSON object. Requires the `MANAGE_REQUESTS` permission.
Update media status
Updates a media item's status and returns the media in JSON format
Update Metadata settings
Updates Metadata settings with the provided values.
Update network settings
Updates network settings with the provided values.
Update notification settings for a user
Updates and returns notification settings for a specific user. Requires `MANAGE_USERS` permission if editing other users.
Update ntfy.sh notification settings
Update ntfy.sh notification settings with the provided values.
Update override rule
Updates an Override Rule from the request body.
Update password for a user
Updates a user's password. Requires `MANAGE_USERS` permission if editing other users.
Update permission settings for a user
Updates and returns permission settings for a specific user. Requires `MANAGE_USERS` permission if editing other users.
Update Plex settings
Updates Plex settings with the provided values.
Update Pushbullet notification settings
Update Pushbullet notification settings with the provided values.
Update Pushover notification settings
Update Pushover notification settings with the provided values.
Update Radarr instance
Updates an existing Radarr instance with the provided values.
Update Slack notification settings
Updates Slack notification settings with the provided values.
Update Sonarr instance
Updates an existing Sonarr instance with the provided values.
Update Tautulli settings
Updates Tautulli settings with the provided values.
Update Telegram notification settings
Update Telegram notification settings with the provided values.
Update Web Push notification settings
Updates Web Push notification settings with the provided values.
Update webhook notification settings
Updates webhook notification settings with the provided values.