### Get Logs Source: https://api-docs.overseerr.dev/ Retrieves the application logs. ```APIDOC ## GET /settings/logs ### Description Returns logs ### Method GET ### Endpoint /settings/logs ``` -------------------------------- ### Get Public Settings Source: https://api-docs.overseerr.dev/ Retrieves public-facing settings. ```APIDOC ## GET /settings/public ### Description Get public settings ### Method GET ### Endpoint /settings/public ``` -------------------------------- ### Get Main Settings Source: https://api-docs.overseerr.dev/overseerr-api.yml Retrieves all main settings in a JSON object. ```APIDOC ## GET /settings/main ### Description Retrieves all main settings in a JSON object. ### Method GET ### Endpoint /settings/main ### Response #### Success Response (200) - **content** (application/json) - Schema reference: '#/components/schemas/MainSettings' ``` -------------------------------- ### Get Plex Settings Source: https://api-docs.overseerr.dev/ Retrieves the Plex integration settings. ```APIDOC ## GET /settings/plex ### Description Get Plex settings ### Method GET ### Endpoint /settings/plex ``` -------------------------------- ### Get Radarr Settings Source: https://api-docs.overseerr.dev/overseerr-api.yml Retrieves all Radarr settings. ```APIDOC ## GET /settings/radarr ### Description Get Radarr settings. Returns all Radarr settings in a JSON array. ### Method GET ### Endpoint /settings/radarr ### Response #### Success Response (200) - **Values were returned** (array) - Description of values were returned #### Response Example { "example": "[ RadarrSettings ]" } ``` -------------------------------- ### Get Tautulli Settings Source: https://api-docs.overseerr.dev/ Retrieves the Tautulli integration settings. ```APIDOC ## GET /settings/tautulli ### Description Get Tautulli settings ### Method GET ### Endpoint /settings/tautulli ``` -------------------------------- ### Get All Issues Source: https://api-docs.overseerr.dev/ Retrieves a list of all issues. ```APIDOC ## GET /issue ### Description Get all issues ### Method GET ### Endpoint /issue ``` -------------------------------- ### Get Tautulli Settings Source: https://api-docs.overseerr.dev/overseerr-api.yml Retrieves the current Tautulli settings. ```APIDOC ## GET /settings/tautulli ### Description Get Tautulli settings. Retrieves current Tautulli settings. ### Method GET ### Endpoint /settings/tautulli ### Response #### Success Response (200) - **OK** (object) - Description of OK #### Response Example { "example": "TautulliSettings" } ``` -------------------------------- ### Start Plex Library Scan Source: https://api-docs.overseerr.dev/ Initiates a full scan of the Plex library. ```APIDOC ## POST /settings/plex/sync ### Description Start full Plex library scan ### Method POST ### Endpoint /settings/plex/sync ``` -------------------------------- ### Get Logs Source: https://api-docs.overseerr.dev/overseerr-api.yml Retrieves a list of all log items and their details. ```APIDOC ## Get Logs ### Description Returns list of all log items and details. ### Method GET ### Endpoint /settings/logs ### Parameters #### Query Parameters - **take** (number) - Optional - The number of log items to retrieve. - **skip** (number) - Optional - The number of log items to skip. - **filter** (string) - Optional - Filters logs by level (debug, info, warn, error). Defaults to debug. - **search** (string) - Optional - Searches logs for a specific term. ### Responses #### Success Response (200) - Description: Server log returned - Content: - **label** (string) - Example: server - **level** (string) - Example: info - **message** (string) - Example: Server ready on port 5055 - **timestamp** (string) - Example: '2020-12-15T16:20:00.069Z' ``` -------------------------------- ### Get Main Settings Source: https://api-docs.overseerr.dev/ Retrieves the main configuration settings for Overseerr. ```APIDOC ## GET /settings/main ### Description Get main settings ### Method GET ### Endpoint /settings/main ``` -------------------------------- ### Get Pushover Sounds Source: https://api-docs.overseerr.dev/ Retrieves a list of available Pushover sounds. ```APIDOC ## GET /settings/notifications/pushover/sounds ### Description Get Pushover sounds ### Method GET ### Endpoint /settings/notifications/pushover/sounds ``` -------------------------------- ### Get Sonarr Settings Source: https://api-docs.overseerr.dev/ Retrieves the Sonarr integration settings. ```APIDOC ## GET /settings/sonarr ### Description Get Sonarr settings ### Method GET ### Endpoint /settings/sonarr ``` -------------------------------- ### Get Discover Sliders Source: https://api-docs.overseerr.dev/ Retrieves all discover sliders. ```APIDOC ## GET /settings/discover ### Description Get all discover sliders ### Method GET ### Endpoint /settings/discover ``` -------------------------------- ### Initialize Application Source: https://api-docs.overseerr.dev/overseerr-api.yml Marks the application as initialized, enabling full user access beyond the setup page. ```APIDOC ## POST /settings/initialize ### Description Sets the app as initialized, allowing the user to navigate to pages other than the setup page. ### Method POST ### Endpoint /settings/initialize ### Response #### Success Response (200) - **schema** (object) - Reference to the PublicSettings schema. ``` -------------------------------- ### Get Keyword Source: https://api-docs.overseerr.dev/overseerr-api.yml Retrieves a single keyword by its ID. ```APIDOC ## GET /keyword/{keywordId} ### Description Returns a single keyword in JSON format. ### Method GET ### Endpoint /keyword/{keywordId} ### Parameters #### Path Parameters - **keywordId** (number) - Required - The ID of the keyword to retrieve. ### Responses #### Success Response (200) - **Keyword** (object) - The requested keyword details. ### Response Example { "example": "{\"id\":1,\"keyword\":\"example\"}" } ``` -------------------------------- ### Get Plex Watchlist Source: https://api-docs.overseerr.dev/overseerr-api.yml Retrieves the Plex watchlist. Supports pagination. ```APIDOC ## GET /watch ### Description Get the Plex watchlist. ### Method GET ### Endpoint /watch ### Query Parameters - **page** (number) - Optional - The page number for pagination. Defaults to 1. ``` -------------------------------- ### Get Radarr Settings Source: https://api-docs.overseerr.dev/ Retrieves the Radarr integration settings. ```APIDOC ## GET /settings/radarr ### Description Get Radarr settings ### Method GET ### Endpoint /settings/radarr ``` -------------------------------- ### Get Plex Servers Source: https://api-docs.overseerr.dev/ Retrieves the list of available Plex servers for the user. ```APIDOC ## GET /settings/plex/devices/servers ### Description Gets the user's available Plex servers ### Method GET ### Endpoint /settings/plex/devices/servers ``` -------------------------------- ### Get Server Stats Source: https://api-docs.overseerr.dev/ Retrieves server statistics. ```APIDOC ## GET /settings/about ### Description Get server stats ### Method GET ### Endpoint /settings/about ``` -------------------------------- ### Start Plex Library Scan Source: https://api-docs.overseerr.dev/overseerr-api.yml Runs a full Plex library scan and returns the progress in a JSON array. ```APIDOC ## POST /settings/plex/sync ### Description Runs a full Plex library scan and returns the progress in a JSON array. ### Method POST ### Endpoint /settings/plex/sync ### Request Body - **content** (application/json) - Schema: type: object properties: cancel (boolean) - Example: false start (boolean) - Example: false ### Response #### Success Response (200) - **content** (application/json) - Type: object, Properties: - **running** (boolean) - Example: false - **progress** (number) - Example: 0 - **total** (number) - Example: 100 - **currentLibrary** - Schema reference: '#/components/schemas/PlexLibrary' - **libraries** (array) - Items schema: '#/components/schemas/PlexLibrary' ``` -------------------------------- ### Get Trending Backdrops Source: https://api-docs.overseerr.dev/ Retrieves backdrops for trending items. ```APIDOC ## GET /backdrops ### Description Get backdrops of trending items ### Method GET ### Endpoint /backdrops ``` -------------------------------- ### Get Plex Libraries Source: https://api-docs.overseerr.dev/ Retrieves the list of available Plex libraries. ```APIDOC ## GET /settings/plex/library ### Description Get Plex libraries ### Method GET ### Endpoint /settings/plex/library ``` -------------------------------- ### Get Media Source: https://api-docs.overseerr.dev/overseerr-api.yml Retrieves a list of all media items, with options to filter, paginate, and sort the results. ```APIDOC ## GET /media ### Description Returns all media (can be filtered and limited) in a JSON object. ### Method GET ### Endpoint /media ### Parameters #### Query Parameters - **take** (number) - Optional - The maximum number of items to return. - **skip** (number) - Optional - The number of items to skip from the beginning. - **filter** (string) - Optional - Filters the media by status. Allowed values: `all`, `available`, `partial`, `allavailable`, `processing`, `pending`, `deleted`. - **sort** (string) - Optional - Sorts the media. Allowed values: `added`, `modified`, `mediaAdded`. Defaults to `added`. ### Response #### Success Response (200) - **pageInfo** (object) - Information about the current page of results. - **results** (array) - An array of media information objects. #### Response Example (Example response structure would be detailed here if provided in source) ``` -------------------------------- ### Get Logged-in User Source: https://api-docs.overseerr.dev/ Retrieves information about the currently authenticated user. ```APIDOC ## GET /auth/me ### Description Get logged-in user ### Method GET ### Endpoint /auth/me ``` -------------------------------- ### Get All Users Source: https://api-docs.overseerr.dev/overseerr-api.yml Retrieves a list of all users within the system, with options for pagination and sorting. ```APIDOC ## GET /user ### Description Returns all users in a JSON object. ### Method GET ### Endpoint /user ### Parameters #### Query Parameters - **take** (number) - Optional - The maximum number of users to return. - **skip** (number) - Optional - The number of users to skip before starting to collect the result set. - **sort** (string) - Optional - The field to sort users by. Possible values: `created`, `updated`, `requests`, `displayname`. Defaults to `created`. ### Response #### Success Response (200) - **pageInfo** (object) - Information about the pagination. - **results** (array) - An array of user objects. #### Response Example { "pageInfo": { ... }, "results": [ { ... user object ... } ] } ``` -------------------------------- ### Get Radarr Server Details Source: https://api-docs.overseerr.dev/overseerr-api.yml Retrieves quality profiles and root folders for a specific Radarr server. ```APIDOC ## GET /service/radarr/{radarrId} ### Description Returns a Radarr server's quality profile and root folder details in a JSON object. ### Method GET ### Endpoint /service/radarr/{radarrId} ### Parameters #### Path Parameters - **radarrId** (number) - Required - Radarr server ID. ### Response #### Success Response (200) - **server** (object) - Radarr server settings. - **profiles** (object) - Quality profiles for the Radarr server. #### Response Example { "server": { "id": 0, "name": "My Radarr Server" }, "profiles": [ { "id": 1, "name": "4K" } ] } ``` -------------------------------- ### Get Sonarr Server Details Source: https://api-docs.overseerr.dev/overseerr-api.yml Retrieves quality profiles and root folders for a specific Sonarr server. ```APIDOC ## GET /service/sonarr/{sonarrId} ### Description Returns a Sonarr server's quality profile and root folder details in a JSON object. ### Method GET ### Endpoint /service/sonarr/{sonarrId} ### Parameters #### Path Parameters - **sonarrId** (number) - Required - Sonarr server ID. ### Response #### Success Response (200) - **server** (object) - Sonarr server settings. - **profiles** (object) - Quality profiles for the Sonarr server. #### Response Example { "server": { "id": 0, "name": "My Sonarr Server" }, "profiles": [ { "id": 1, "name": "720p" } ] } ``` -------------------------------- ### Get Radarr Profiles Source: https://api-docs.overseerr.dev/ Retrieves the available Radarr profiles for a given instance. ```APIDOC ## GET /settings/radarr/{radarrId}/profiles ### Description Get available Radarr profiles ### Method GET ### Endpoint /settings/radarr/{radarrId}/profiles ``` -------------------------------- ### Get Pushover Notification Settings Source: https://api-docs.overseerr.dev/ Retrieves the Pushover notification settings. ```APIDOC ## GET /settings/notifications/pushover ### Description Get Pushover notification settings ### Method GET ### Endpoint /settings/notifications/pushover ``` -------------------------------- ### Get Slack Notification Settings Source: https://api-docs.overseerr.dev/ Retrieves the Slack notification settings. ```APIDOC ## GET /settings/notifications/slack ### Description Get Slack notification settings ### Method GET ### Endpoint /settings/notifications/slack ``` -------------------------------- ### Get Plex Users Source: https://api-docs.overseerr.dev/ Retrieves the list of Plex users associated with the account. ```APIDOC ## GET /settings/plex/users ### Description Get Plex users ### Method GET ### Endpoint /settings/plex/users ``` -------------------------------- ### Get All Discover Sliders Source: https://api-docs.overseerr.dev/overseerr-api.yml Returns all discovery sliders, including built-in and custom-made ones. ```APIDOC ## GET /settings/discover ### Description Returns all discovery sliders. Built-in and custom made. ### Method GET ### Endpoint /settings/discover ### Response #### Success Response (200) - Description: Returned all discovery sliders - **body** (array) - Array of DiscoverSlider objects ``` -------------------------------- ### Get User Settings Source: https://api-docs.overseerr.dev/overseerr-api.yml Returns general settings for a specific user. Requires `MANAGE_USERS` permission if viewing other users. ```APIDOC ## GET /user/{userId}/settings/main ### Description Returns general settings for a specific user. Requires `MANAGE_USERS` permission if viewing other users. ### Method GET ### Endpoint /user/{userId}/settings/main ### Parameters #### Path Parameters - **userId** (number) - Required - The ID of the user whose settings to retrieve. ``` -------------------------------- ### Get All Issues Source: https://api-docs.overseerr.dev/overseerr-api.yml Retrieves a list of all issues, with options for pagination, sorting, filtering, and requesting by a specific user. ```APIDOC ## GET /issue ### Description Returns a list of issues in JSON format. ### Method GET ### Endpoint /issue ### Parameters #### Query Parameters - **take** (number) - Optional - The number of issues to return. - **skip** (number) - Optional - The number of issues to skip. - **sort** (string) - Optional - The sorting order for issues. Enum: [added, modified]. Defaults to 'added'. - **filter** (string) - Optional - The filter for issues. Enum: [all, open, resolved]. Defaults to 'open'. - **requestedBy** (number) - Optional - Filter issues requested by a specific user ID. ### Response #### Success Response (200) - **pageInfo** (PageInfo) - Information about the pagination. - **results** (array) - An array of Issue objects. #### Response Example { "pageInfo": {}, "results": [ {} ] } ``` -------------------------------- ### Get All Requests Source: https://api-docs.overseerr.dev/overseerr-api.yml Retrieves all media requests. Access is restricted based on user permissions. Supports filtering, sorting, and pagination. ```APIDOC ## GET /request ### Description Returns all requests if the user has the `ADMIN` or `MANAGE_REQUESTS` permissions. Otherwise, only the logged-in user's requests are returned. If the `requestedBy` parameter is specified, only requests from that particular user ID will be returned. ### Method GET ### Endpoint /request ### Query Parameters - **take** (number) - Optional - The number of requests to return. - **skip** (number) - Optional - The number of requests to skip. - **filter** (string) - Optional - Filters requests by status. Possible values: `all`, `approved`, `available`, `pending`, `processing`, `unavailable`, `failed`, `deleted`, `completed`. - **sort** (string) - Optional - Sorts requests by `added` or `modified`. Defaults to `added`. - **requestedBy** (number) - Optional - Filters requests by the user ID of the requester. ``` -------------------------------- ### Get Web Push Notification Settings Source: https://api-docs.overseerr.dev/ Retrieves the Web Push notification settings. ```APIDOC ## GET /settings/notifications/webpush ### Description Get Web Push notification settings ### Method GET ### Endpoint /settings/notifications/webpush ``` -------------------------------- ### Get Available Radarr Profiles Source: https://api-docs.overseerr.dev/overseerr-api.yml Returns a list of profiles available on the Radarr server instance in a JSON array. ```APIDOC ## GET /settings/radarr/{radarrId}/profiles ### Description Returns a list of profiles available on the Radarr server instance in a JSON array. ### Method GET ### Endpoint /settings/radarr/{radarrId}/profiles ### Parameters #### Path Parameters - **radarrId** (integer) - Required - Radarr instance ID ### Response #### Success Response (200) - **array** - Returned list of profiles ``` -------------------------------- ### Initialize Application Source: https://api-docs.overseerr.dev/ Initializes the Overseerr application. ```APIDOC ## POST /settings/initialize ### Description Initialize application ### Method POST ### Endpoint /settings/initialize ``` -------------------------------- ### Get Service Details Source: https://api-docs.overseerr.dev/overseerr-api.yml Retrieves details about the connected services (Radarr/Sonarr). Requires API key authentication. ```APIDOC ## GET /service ### Description Retrieves details about the connected services (Radarr/Sonarr). ### Method GET ### Endpoint /service ### Parameters #### Query Parameters - **apiKey** (string) - Required - The API key for authentication. ### Response #### Success Response (200) - **radarr** (object) - Details about the Radarr instance. - **id** (integer) - The ID of the Radarr instance. - **name** (string) - The name of the Radarr instance. - **active** (boolean) - Whether the Radarr instance is active. - **version** (string) - The version of Radarr. - **sonarr** (object) - Details about the Sonarr instance. - **id** (integer) - The ID of the Sonarr instance. - **name** (string) - The name of the Sonarr instance. - **active** (boolean) - Whether the Sonarr instance is active. - **version** (string) - The version of Sonarr. #### Response Example { "radarr": { "id": 1, "name": "Radarr", "active": true, "version": "3.0.0" }, "sonarr": { "id": 2, "name": "Sonarr", "active": true, "version": "3.0.0" } } ``` -------------------------------- ### Get Movie Studio Details Source: https://api-docs.overseerr.dev/ Retrieves details for a specific movie studio by its ID. ```APIDOC ## GET /studio/{studioId} ### Description Get movie studio details ### Method GET ### Endpoint /studio/{studioId} ### Parameters #### Path Parameters - **studioId** (integer) - Required - The ID of the studio to retrieve. ``` -------------------------------- ### Create Sonarr Instance Source: https://api-docs.overseerr.dev/ Creates a new Sonarr integration instance. ```APIDOC ## POST /settings/sonarr ### Description Create Sonarr instance ### Method POST ### Endpoint /settings/sonarr ``` -------------------------------- ### Get Issue Counts Source: https://api-docs.overseerr.dev/ Retrieves the counts of issues. ```APIDOC ## GET /issue/count ### Description Gets issue counts ### Method GET ### Endpoint /issue/count ``` -------------------------------- ### Get Movies from Keyword Source: https://api-docs.overseerr.dev/overseerr-api.yml Retrieves a list of movies associated with a specific keyword ID. Supports pagination and language filtering. ```APIDOC ## GET /discover/keyword/{keywordId}/movies ### Description Returns list of movies based on the provided keyword ID in a JSON object. ### Method GET ### Endpoint /discover/keyword/{keywordId}/movies ### Parameters #### Path Parameters - **keywordId** (number) - Required - The ID of the keyword to search for. #### Query Parameters - **page** (number) - Optional - The page number to retrieve. Defaults to 1. - **language** (string) - Optional - The language code for the results. Defaults to 'en'. ### Response #### Success Response (200) - **page** (number) - The current page number. - **totalPages** (number) - The total number of pages available. - **totalResults** (number) - The total number of results. - **results** (array) - An array of movie results. ### Response Example { "page": 1, "totalPages": 20, "totalResults": 200, "results": [ { "adult": false, "backdrop_path": "/path/to/backdrop.jpg", "genre_ids": [12, 14], "id": 123, "original_language": "en", "original_title": "Original Title", "overview": "Overview of the movie.", "popularity": 100.5, "poster_path": "/path/to/poster.jpg", "release_date": "2023-01-01", "title": "Movie Title", "video": false, "vote_average": 8.0, "vote_count": 1000 } ] } ``` -------------------------------- ### Get User Push Subscriptions Source: https://api-docs.overseerr.dev/overseerr-api.yml Retrieves all web push notification settings for a specific user. ```APIDOC ## GET /user/{userId}/pushSubscriptions ### Description Returns all web push notification settings for a user in a JSON object. ### Method GET ### Endpoint /user/{userId}/pushSubscriptions ### Parameters #### Path Parameters - **userId** (number) - Required - The ID of the user. ### Response #### Success Response (200) - Description: User web push notification settings in JSON. - **endpoint** (string) - The push subscription endpoint. - **p256dh** (string) - The P256dh key for the push subscription. - **auth** (string) - The authentication key for the push subscription. - **userAgent** (string) - The user agent string. ``` -------------------------------- ### Get User List Source: https://api-docs.overseerr.dev/overseerr-api.yml Retrieves a list of all users on the Overseerr instance. Requires API key authentication. ```APIDOC ## GET /users ### Description Retrieves a list of all users on the Overseerr instance. ### Method GET ### Endpoint /users ### Parameters #### Query Parameters - **apiKey** (string) - Required - The API key for authentication. ### Response #### Success Response (200) - **users** (array) - A list of user objects. - **id** (integer) - The ID of the user. - **email** (string) - The email of the user. - **username** (string) - The username of the user. - **plexToken** (string) - The Plex token of the user. - **plexUsername** (string) - The Plex username of the user. - **userType** (integer) - The type of the user. - **permissions** (number) - The permissions of the user. - **avatar** (string) - The avatar URL of the user. - **createdAt** (string) - The creation date of the user. - **updatedAt** (string) - The last update date of the user. - **requestCount** (number) - The number of requests made by the user. #### Response Example { "users": [ { "id": 1, "email": "hey@itsme.com", "username": "testuser", "plexToken": "xxxxxxxxxxxxxxxxxxxx", "plexUsername": "Test User", "userType": 1, "permissions": 0, "avatar": "/avatar/1.png", "createdAt": "2020-09-02T05:02:23.000Z", "updatedAt": "2020-09-02T05:02:23.000Z", "requestCount": 5 } ] } ``` -------------------------------- ### Get User Watchlist Source: https://api-docs.overseerr.dev/overseerr-api.yml Retrieves a user's Plex Watchlist in a JSON object. Supports pagination. ```APIDOC ## GET /user/{userId}/watchlist ### Description Retrieves a user's Plex Watchlist in a JSON object. ### Method GET ### Endpoint /user/{userId}/watchlist ### Parameters #### Path Parameters - **userId** (number) - Required - The ID of the user whose watchlist to retrieve. #### Query Parameters - **page** (number) - Optional - The page number of the watchlist to retrieve. Defaults to 1. ### Response #### Success Response (200) - **page** (number) - The current page number. - **totalPages** (number) - The total number of pages available. - **totalResults** (number) - The total number of items in the watchlist. - **results** (array) - An array of watchlist items. - **tmdbId** (number) - The TMDB ID of the item. - **ratingKey** (string) - The rating key of the item. - **type** (string) - The type of the item (e.g., movie, show). - **title** (string) - The title of the item. ``` -------------------------------- ### Get Recommended Movies Source: https://api-docs.overseerr.dev/overseerr-api.yml Fetches a list of recommended movies based on a provided movie ID. Supports pagination and language filtering. ```APIDOC ## GET /movie/{movieId}/recommendations ### Description Returns list of recommended movies based on provided movie ID in a JSON object. ### Method GET ### Endpoint /movie/{movieId}/recommendations ### Parameters #### Path Parameters - **movieId** (number) - Required - The ID of the movie to get recommendations for. #### Query Parameters - **page** (number) - Optional - The page number for the recommendations list. Defaults to 1. - **language** (string) - Optional - The language code for the movie details. Defaults to 'en'. ### Response #### Success Response (200) - **page** (number) - The current page number. - **totalPages** (number) - The total number of pages available. - **totalResults** (number) - The total number of recommended movies. - **results** (array) - An array of movie result objects. ### Response Example ```json { "page": 1, "totalPages": 20, "totalResults": 200, "results": [ { "id": 123, "title": "Example Movie", "overview": "This is an example movie." } ] } ``` ``` -------------------------------- ### Create Radarr Instance Source: https://api-docs.overseerr.dev/ Creates a new Radarr integration instance. ```APIDOC ## POST /settings/radarr ### Description Create Radarr instance ### Method POST ### Endpoint /settings/radarr ``` -------------------------------- ### Get User General Settings Source: https://api-docs.overseerr.dev/overseerr-api.yml Retrieves the general settings for a specific user. Requires `MANAGE_USERS` permission if viewing other users. ```APIDOC ## GET /user/{userId}/settings ### Description Retrieves the general settings for a specific user. Requires `MANAGE_USERS` permission if viewing other users. ### Method GET ### Endpoint /user/{userId}/settings ### Parameters #### Path Parameters - **userId** (number) - Required - The ID of the user to retrieve settings for. ### Response #### Success Response (200) - **username** (string) - The username of the user. ``` -------------------------------- ### Import All Users from Plex Source: https://api-docs.overseerr.dev/overseerr-api.yml Fetches and imports users from the Plex server. If a list of Plex IDs is provided, only those users are imported; otherwise, all users are imported. ```APIDOC ## POST /user/import-from-plex ### Description 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. ### Method POST ### Endpoint /user/import-from-plex ### Parameters #### Request Body - **plexIds** (array) - Optional - A list of Plex IDs to import. If omitted, all users will be imported. ### Request Example { "plexIds": [123, 456, 789] } ### Response #### Success Response (200) - (object) - Response indicating the success of the import operation. #### Response Example { "message": "Users imported successfully." } ``` -------------------------------- ### Get Search Results Source: https://api-docs.overseerr.dev/overseerr-api.yml Searches for movies and TV shows. Requires API key authentication. ```APIDOC ## GET /search ### Description Searches for movies and TV shows. ### Method GET ### Endpoint /search ### Parameters #### Query Parameters - **apiKey** (string) - Required - The API key for authentication. - **query** (string) - Required - The search query. ### Response #### Success Response (200) - **results** (array) - A list of search results. - **id** (integer) - The ID of the media item. - **title** (string) - The title of the media item. - **year** (integer) - The year of the media item. - **type** (string) - The type of media ('movie' or 'tv'). - **posterPath** (string) - The path to the poster image. #### Response Example { "results": [ { "id": 123, "title": "Example Movie", "year": 2023, "type": "movie", "posterPath": "/poster.jpg" }, { "id": 456, "title": "Example TV Show", "year": 2023, "type": "tv", "posterPath": "/poster.jpg" } ] } ``` -------------------------------- ### Get Movie Details Source: https://api-docs.overseerr.dev/overseerr-api.yml Retrieves details for a specific movie by its ID. Requires API key authentication. ```APIDOC ## GET /movie/{id} ### Description Retrieves details for a specific movie by its ID. ### Method GET ### Endpoint /movie/{id} ### Parameters #### Path Parameters - **id** (integer) - Required - The ID of the movie to retrieve. #### Query Parameters - **apiKey** (string) - Required - The API key for authentication. ### Response #### Success Response (200) - **id** (integer) - The ID of the movie. - **title** (string) - The title of the movie. - **year** (integer) - The year of the movie. - **overview** (string) - The overview of the movie. - **posterPath** (string) - The path to the poster image. - **releaseDate** (string) - The release date of the movie. - **genres** (array) - A list of genres associated with the movie. #### Response Example { "id": 123, "title": "Example Movie", "year": 2023, "overview": "This is an example movie.", "posterPath": "/poster.jpg", "releaseDate": "2023-01-01", "genres": [ "Action", "Sci-Fi" ] } ``` -------------------------------- ### Get Similar Movies Source: https://api-docs.overseerr.dev/overseerr-api.yml Fetches a list of movies similar to a given movie ID. Supports pagination and language filtering. ```APIDOC ## GET /movie/{movieId}/similar ### Description Returns list of similar movies based on the provided movieId in a JSON object. ### Method GET ### Endpoint /movie/{movieId}/similar ### Parameters #### Path Parameters - **movieId** (number) - Required - The ID of the movie to find similar movies for. #### Query Parameters - **page** (number) - Optional - The page number for the similar movies list. Defaults to 1. - **language** (string) - Optional - The language code for the movie details. Defaults to 'en'. ### Response #### Success Response (200) - **page** (number) - The current page number. - **totalPages** (number) - The total number of pages available. - **totalResults** (number) - The total number of similar movies. - **results** (array) - An array of movie result objects. ### Response Example ```json { "page": 1, "totalPages": 20, "totalResults": 200, "results": [ { "id": 456, "title": "Another Example Movie", "overview": "This is another example movie." } ] } ``` ``` -------------------------------- ### Get Issue by ID Source: https://api-docs.overseerr.dev/ Retrieves a specific issue by its ID. ```APIDOC ## GET /issue/{issueId} ### Description Get issue ### Method GET ### Endpoint /issue/{issueId} ### Parameters #### Path Parameters - **issueId** (integer) - Required - The ID of the issue to retrieve. ``` -------------------------------- ### Get Languages Source: https://api-docs.overseerr.dev/ Retrieves a list of languages supported by TMDB. ```APIDOC ## GET /languages ### Description Languages supported by TMDB ### Method GET ### Endpoint /languages ``` -------------------------------- ### Get Active Caches Source: https://api-docs.overseerr.dev/ Retrieves a list of all active caches. ```APIDOC ## GET /settings/cache ### Description Get a list of active caches ### Method GET ### Endpoint /settings/cache ``` -------------------------------- ### Create New Request Source: https://api-docs.overseerr.dev/overseerr-api.yml Creates a new media request. Requires the `REQUEST` permission. Auto-approval is possible based on user permissions. ```APIDOC ## POST /request ### Description Creates a new request with the provided media ID and type. The `REQUEST` permission is required. If the user has the `ADMIN` or `AUTO_APPROVE` permissions, their request will be auomatically approved. ### Method POST ### Endpoint /request ### Request Body - **mediaType** (string) - Required - The type of media. Enum: `movie`, `tv`. - **mediaId** (number) - Required - The ID of the media. - **tvdbId** (number) - Optional - The TVDB ID of the media. - **seasons** (array of numbers or string) - Optional - The seasons to request. Can be an array of season numbers or the string `all`. - **is4k** (boolean) - Optional - Whether to request the 4K version. - **serverId** (number) - Optional - The ID of the server. - **profileId** (number) - Optional - The ID of the profile. - **rootFolder** (string) - Optional - The root folder for the media. - **languageProfileId** (number) - Optional - The ID of the language profile. - **userId** (number) - Optional - The ID of the user making the request. ### Response #### Success Response (201) - **MediaRequest** (object) - The created media request object. ``` -------------------------------- ### Get Scheduled Jobs Source: https://api-docs.overseerr.dev/ Retrieves a list of all scheduled jobs. ```APIDOC ## GET /settings/jobs ### Description Get scheduled jobs ### Method GET ### Endpoint /settings/jobs ``` -------------------------------- ### Get User Quotas Source: https://api-docs.overseerr.dev/overseerr-api.yml Returns quota details for a user in a JSON object. Requires `MANAGE_USERS` permission if viewing other users. ```APIDOC ## GET /user/{userId}/quota ### Description Returns quota details for a user in a JSON object. Requires `MANAGE_USERS` permission if viewing other users. ### Method GET ### Endpoint /user/{userId}/quota ### Parameters #### Path Parameters - **userId** (number) - Required - The ID of the user whose quotas to retrieve. ### Response #### Success Response (200) - **movie** (object) - Movie quota details. - **days** (number) - The number of days the quota is valid for. - **limit** (number) - The maximum number of movies allowed. - **used** (number) - The number of movies currently used. - **remaining** (number) - The number of movies remaining. - **restricted** (boolean) - Whether the movie quota is restricted. - **tv** (object) - TV show quota details. - **days** (number) - The number of days the quota is valid for. - **limit** (number) - The maximum number of TV shows allowed. - **used** (number) - The number of TV shows currently used. - **remaining** (number) - The number of TV shows remaining. - **restricted** (boolean) - Whether the TV show quota is restricted. ``` -------------------------------- ### Regenerate Main Settings API Key Source: https://api-docs.overseerr.dev/ Retrieves main settings with a newly generated API key. ```APIDOC ## POST /settings/main/regenerate ### Description Get main settings with newly-generated API key ### Method POST ### Endpoint /settings/main/regenerate ``` -------------------------------- ### Sign in with Plex Token Source: https://api-docs.overseerr.dev/ Authenticates the user by providing a Plex token. ```APIDOC ## POST /auth/plex ### Description Sign in using a Plex token ### Method POST ### Endpoint /auth/plex ``` -------------------------------- ### Create New User Source: https://api-docs.overseerr.dev/overseerr-api.yml Creates a new user account. This operation requires the `MANAGE_USERS` permission. ```APIDOC ## POST /user ### Description Creates a new user. Requires the `MANAGE_USERS` permission. ### Method POST ### Endpoint /user ### Parameters #### Request Body - **email** (string) - Required - The email address of the new user. - **username** (string) - The username for the new user. - **permissions** (number) - The permissions to assign to the new user. ### Request Example { "email": "hey@itsme.com", "username": "newuser", "permissions": 1 } ### Response #### Success Response (201) - (object) - The newly created user object. #### Response Example { "id": 1, "email": "hey@itsme.com", "username": "newuser", "permissions": 1 // ... other user properties } ``` -------------------------------- ### Get Plex Settings Source: https://api-docs.overseerr.dev/overseerr-api.yml Retrieves Plex settings for the Overseerr instance, including server details and connected libraries. Requires API key authentication. ```APIDOC ## GET /settings/plex ### Description Retrieves Plex settings for the Overseerr instance. ### Method GET ### Endpoint /settings/plex ### Parameters #### Query Parameters - **apiKey** (string) - Required - The API key for authentication. ### Response #### Success Response (200) - **name** (string) - The name of the Plex server. - **machineId** (string) - The machine ID of the Plex server. - **ip** (string) - The IP address of the Plex server. - **port** (number) - The port of the Plex server. - **useSsl** (boolean) - Whether SSL is used for the Plex connection. - **libraries** (array) - A list of Plex libraries. - **id** (string) - The ID of the library. - **name** (string) - The name of the library. - **enabled** (boolean) - Whether the library is enabled. - **webAppUrl** (string) - The URL for the Plex web app. #### Response Example { "name": "Main Server", "machineId": "1234123412341234", "ip": "127.0.0.1", "port": 32400, "useSsl": true, "libraries": [ { "id": "1", "name": "Movies", "enabled": true } ], "webAppUrl": "https://app.plex.tv/desktop" } ``` -------------------------------- ### Get Request Counts Source: https://api-docs.overseerr.dev/overseerr-api.yml Retrieves the counts of pending and approved requests. ```APIDOC ## GET /request/count ### Description Returns the number of pending and approved requests. ### Method GET ### Endpoint /request/count ### Response #### Success Response (200) - **pending** (number) - The number of pending requests. - **approved** (number) - The number of approved requests. ``` -------------------------------- ### Test Web Push Settings Source: https://api-docs.overseerr.dev/overseerr-api.yml Sends a test notification to the Web Push agent. ```APIDOC ## POST /settings/notifications/webpush/test ### Description Sends a test notification to the Web Push agent. ### Method POST ### Endpoint /settings/notifications/webpush/test ### Request Body - **body** (object) - Required - WebPushSettings schema ### Response #### Success Response (204) - Description: Test notification attempted ``` -------------------------------- ### Get Issue Comment Source: https://api-docs.overseerr.dev/ Retrieves a specific issue comment by its ID. ```APIDOC ## GET /issueComment/{commentId} ### Description Get issue comment ### Method GET ### Endpoint /issueComment/{commentId} ### Parameters #### Path Parameters - **commentId** (integer) - Required - The ID of the comment to retrieve. ``` -------------------------------- ### Get Webhook Notification Settings Source: https://api-docs.overseerr.dev/ Retrieves the webhook notification settings. ```APIDOC ## GET /settings/notifications/webhook ### Description Get webhook notification settings ### Method GET ### Endpoint /settings/notifications/webhook ``` -------------------------------- ### Sign in using local account Source: https://api-docs.overseerr.dev/overseerr-api.yml Authenticates a user with local credentials (email and password). This generates a session cookie for subsequent requests. ```APIDOC ## POST /auth/local ### Description Takes an `email` and a `password` to log the user in. Generates a session cookie for use in further requests. ### Method POST ### Endpoint /auth/local ### Request Body - **email** (string) - Required - **password** (string) - Required ### Response #### Success Response (200) - **User** - Object containing the logged-in user in JSON. ``` -------------------------------- ### Get Telegram Notification Settings Source: https://api-docs.overseerr.dev/ Retrieves the Telegram notification settings. ```APIDOC ## GET /settings/notifications/telegram ### Description Get Telegram notification settings ### Method GET ### Endpoint /settings/notifications/telegram ``` -------------------------------- ### Get Gotify Notification Settings Source: https://api-docs.overseerr.dev/ Retrieves the Gotify notification settings. ```APIDOC ## GET /settings/notifications/gotify ### Description Get Gotify notification settings ### Method GET ### Endpoint /settings/notifications/gotify ``` -------------------------------- ### Sign in using Plex token Source: https://api-docs.overseerr.dev/overseerr-api.yml Authenticates a user using a Plex token. This will generate a session cookie. If no user exists, an admin user will be created. ```APIDOC ## POST /auth/plex ### Description 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. ### Method POST ### Endpoint /auth/plex ### Request Body - **authToken** (string) - Required ### Response #### Success Response (200) - **User** - Object containing the logged-in user in JSON. ``` -------------------------------- ### Test Gotify Settings Source: https://api-docs.overseerr.dev/ Tests the current Gotify notification settings. ```APIDOC ## POST /settings/notifications/gotify/test ### Description Test Gotify settings ### Method POST ### Endpoint /settings/notifications/gotify/test ``` -------------------------------- ### Get Pushbullet Notification Settings Source: https://api-docs.overseerr.dev/ Retrieves the Pushbullet notification settings. ```APIDOC ## GET /settings/notifications/pushbullet ### Description Get Pushbullet notification settings ### Method GET ### Endpoint /settings/notifications/pushbullet ``` -------------------------------- ### Get LunaSea Notification Settings Source: https://api-docs.overseerr.dev/ Retrieves the LunaSea notification settings. ```APIDOC ## GET /settings/notifications/lunasea ### Description Get LunaSea notification settings ### Method GET ### Endpoint /settings/notifications/lunasea ``` -------------------------------- ### Get Discord Notification Settings Source: https://api-docs.overseerr.dev/ Retrieves the Discord notification settings. ```APIDOC ## GET /settings/notifications/discord ### Description Get Discord notification settings ### Method GET ### Endpoint /settings/notifications/discord ``` -------------------------------- ### Test Pushover Settings Source: https://api-docs.overseerr.dev/ Tests the current Pushover notification settings. ```APIDOC ## POST /settings/notifications/pushover/test ### Description Test Pushover settings ### Method POST ### Endpoint /settings/notifications/pushover/test ``` -------------------------------- ### Get Email Notification Settings Source: https://api-docs.overseerr.dev/ Retrieves the email notification settings. ```APIDOC ## GET /settings/notifications/email ### Description Get email notification settings ### Method GET ### Endpoint /settings/notifications/email ``` -------------------------------- ### Update Plex Settings Source: https://api-docs.overseerr.dev/ Updates the Plex integration settings. ```APIDOC ## POST /settings/plex ### Description Update Plex settings ### Method POST ### Endpoint /settings/plex ``` -------------------------------- ### Get Overseerr Status Source: https://api-docs.overseerr.dev/ Retrieves the current status of the Overseerr application. ```APIDOC ## GET /status ### Description Get Overseerr status ### Method GET ### Endpoint /status ``` -------------------------------- ### Test Web Push Settings Source: https://api-docs.overseerr.dev/ Tests the current Web Push notification settings. ```APIDOC ## POST /settings/notifications/webpush/test ### Description Test Web Push settings ### Method POST ### Endpoint /settings/notifications/webpush/test ```