users

Get general settings for a user

Changed on

Returns general settings for a specific user. Requires MANAGE_USERS permission if viewing other users.

get/user/{userId}/settings/main

Request

  • Base URL: http://localhost:5055/api/v1
  • URL: http://localhost:5055/api/v1/user/{userId}/settings/main
  • Auth: one of:
    • API key in cookie connect.sid
    • API key in header X-Api-Key

Path parameters

userIdnumber required

Response

User general settings returned

usernamestring nullable
emailstring
localestring nullable
discoverRegionstring nullable
streamingRegionstring nullable
originalLanguagestring nullable
movieQuotaLimitnumber nullable

Maximum number of movie requests allowed

movieQuotaDaysnumber nullable

Time period in days for movie quota

tvQuotaLimitnumber nullable

Maximum number of TV requests allowed

tvQuotaDaysnumber nullable

Time period in days for TV quota

globalMovieQuotaDaysnumber nullable

Global movie quota days setting

globalMovieQuotaLimitnumber nullable

Global movie quota limit setting

globalTvQuotaLimitnumber nullable

Global TV quota limit setting

globalTvQuotaDaysnumber nullable

Global TV quota days setting

watchlistSyncMoviesboolean nullable

Enable watchlist sync for movies

watchlistSyncTvboolean nullable

Enable watchlist sync for TV

Example response

{
  "username": "Mr User",
  "email": "user@example.com",
  "locale": "en",
  "discoverRegion": "US",
  "streamingRegion": "US",
  "originalLanguage": "en",
  "movieQuotaLimit": 10,
  "movieQuotaDays": 30,
  "tvQuotaLimit": 5,
  "tvQuotaDays": 14,
  "globalMovieQuotaDays": 30,
  "globalMovieQuotaLimit": 10,
  "globalTvQuotaLimit": 5,
  "globalTvQuotaDays": 14,
  "watchlistSyncMovies": true
}

Changes