account.type is one of free, pro, vip. Fields like gender are blank if the user disabled them in their privacy settings.
When to refetch
User settings are set-and-forget in practice — most users configure their timezone / date format / privacy preferences once and never touch them again. Don’t refetch on a timer or on every app launch / wake from background. Instead, gate the refetch on /sync/activities, which returns a settings.all timestamp that bumps when the user changes any account-level preference. Refetch only when that timestamp moves since the value you saved last time. Most launches will do zero extra calls. Full pattern + code example at Dates and timezones → User timezone preference.
using RestSharp;
var options = new RestClientOptions("https://api.simkl.com/users/settings?client_id=");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("User-Agent", "<user-agent>");
request.AddHeader("Authorization", "Bearer <token>");
var response = await client.GetAsync(request);
Console.WriteLine("{0}", response.Content);
using RestSharp;
var options = new RestClientOptions("https://api.simkl.com/users/settings?client_id=");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("User-Agent", "<user-agent>");
request.AddHeader("Authorization", "Bearer <token>");
var response = await client.GetAsync(request);
Console.WriteLine("{0}", response.Content);
{
"error": "client_id_failed",
"code": 412,
"message": "Your client_id is wrong. Try another one"
}
{
"error": "rate_limit",
"code": 429
}
{
"error": "internal",
"code": 500
}
Authorizations
clientId & bearerAuthsimklApiKey & bearerAuth
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
A user access_token, sent as Authorization: Bearer .... Required for endpoints that read or modify the user's library, scrobble session, ratings, settings, or playbacks. Every flow returns the same kind of token. See Set up 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).
Age in years, pre-formatted as a string like "30 years". Empty string if the user has not set their birthday or has disabled age display. Pre-formatted by the server — clients should display verbatim rather than parsing.
Example:
"30 years"
account
object
Hide child attributes
account.id
integer
account.timezone
string
Example:
"Europe/Madrid"
account.type
enum<string>
Simkl account plan tier. free is the default; pro and vip are paid tiers that unlock higher rate limits and additional features. Some endpoints gate behavior on this value.
Available options:
free,
pro,
vip
account.anime_title_language
enum<string>
How the user prefers anime titles to be shown. en is the English title, romaji the transliterated Japanese, native the original Japanese. Honour it when rendering anime titles so your app matches what the user sees on simkl.com.
using RestSharp;
var options = new RestClientOptions("https://api.simkl.com/users/settings?client_id=");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("User-Agent", "<user-agent>");
request.AddHeader("Authorization", "Bearer <token>");
var response = await client.GetAsync(request);
Console.WriteLine("{0}", response.Content);
using RestSharp;
var options = new RestClientOptions("https://api.simkl.com/users/settings?client_id=");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("User-Agent", "<user-agent>");
request.AddHeader("Authorization", "Bearer <token>");
var response = await client.GetAsync(request);
Console.WriteLine("{0}", response.Content);
{
"error": "client_id_failed",
"code": 412,
"message": "Your client_id is wrong. Try another one"
}
{
"error": "rate_limit",
"code": 429
}
{
"error": "internal",
"code": 500
}
{"docsConfig":{"theme":"almond","$schema":"https://mintlify.com/docs.json","name":"Simkl API","description":"Build apps that track Movies, TV Shows, and Anime — scrobble playback, sync watch history, and pull rich metadata from the Simkl API.","colors":{"primary":"#3B82F6","light":"#7DAEFF","dark":"#2563EB"},"logo":{"light":"https://mintcdn.com/andrewmasyk/yVND0Vg0vHbm_kqK/logo/light.svg?fit=max\u0026auto=format\u0026n=yVND0Vg0vHbm_kqK\u0026q=85\u0026s=3ed4c7fdfb9f19455db11c9a13dd466e","dark":"https://mintcdn.com/andrewmasyk/yVND0Vg0vHbm_kqK/logo/dark.svg?fit=max\u0026auto=format\u0026n=yVND0Vg0vHbm_kqK\u0026q=85\u0026s=01045ebbe2fa107aed1f989ec1622647","href":"https://api.simkl.org"},"favicon":"https://mintcdn.com/andrewmasyk/RbJc6mqlYX6FcPwH/favicon.svg?fit=max\u0026auto=format\u0026n=RbJc6mqlYX6FcPwH\u0026q=85\u0026s=d5bd6b8d56f55059c6307fb1e0db9fb7","api":{"openapi":"openapi.json","params":{"expanded":"all"},"playground":{"display":"interactive"},"examples":{"defaults":"required","languages":["curl","python","javascript","typescript","kotlin","swift","java","node","go","csharp","dotnet","php","ruby","powershell","c++","c"],"prefill":true,"autogenerate":true}},"appearance":{"default":"dark","strict":false},"background":{"decoration":"gradient"},"navbar":{"links":[{"href":"https://support.simkl.com","label":"Support"},{"href":"https://discord.gg/MJsWNE4","label":"Discord"}],"primary":{"type":"button","label":"Get an API key","href":"https://simkl.com/settings/developer/"}},"footer":{"socials":{"x":"https://twitter.com/Simkl","discord":"https://discord.gg/MJsWNE4"},"links":[{"header":"Resources","items":[{"label":"Quickstart","href":"/quickstart"},{"label":"API Reference","href":"/api-reference/introduction"},{"label":"Standard objects","href":"/conventions/standard-media-objects"},{"label":"Rate limits","href":"/resources/rate-limits"},{"label":"API rules","href":"/api-rules"},{"label":"OpenAPI 3.1 spec","href":"/openapi.json"}]},{"header":"Simkl","items":[{"label":"Simkl.com","href":"https://simkl.com"},{"label":"Get an API key","href":"https://simkl.com/settings/developer"},{"label":"Status","href":"https://status.simkl.com/"},{"label":"Terms","href":"https://simkl.com/about/policies/terms"}]},{"header":"Community","items":[{"label":"Discord","href":"https://discord.gg/MJsWNE4"},{"label":"X","href":"https://twitter.com/Simkl"}]}]},"seo":{"metatags":{"og:image":"https://i.simkl.com/img_tv/apiary_logo_api.png","og:site_name":"Simkl API"},"indexing":"all"},"fonts":{"family":"Open Sans"},"icons":{"library":"fontawesome"},"styling":{"eyebrows":"breadcrumbs","codeblocks":{"theme":{"light":"github-light","dark":"vesper"}},"latex":false},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","grok","cursor","vscode"],"display":"header"},"thumbnails":{"appearance":"dark"},"navigation":{"global":{"anchors":[]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"andrewmasyk","hasAudioNarration":false,"actualSubdomain":"andrewmasyk","customDomains":["api.simkl.org"],"gitSource":{"type":"github","owner":"simkl","repo":"api-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6afa16e82e6041f078dab076","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"API Reference","count":91},{"language":"default","tag":"Documentation","count":27},{"language":"default","tag":"Auth","count":21},{"language":"default","tag":"AUTH V2","count":11},{"language":"default","tag":"Custom Lists","count":10},{"language":"default","tag":"Sync","count":10},{"language":"default","tag":"AUTH V1","count":9},{"language":"default","tag":"Conventions","count":8},{"language":"default","tag":"Guides","count":8},{"language":"default","tag":"Browse \u0026 discover","count":8}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[{"filePath":"style.css","href":"/_mintlify/custom/andrewmasyk/10e184c8f2642821/style.css"}]}
{"page":{"pagePath":"api-reference/simkl/get-user-settings","slug":"/api-reference/simkl/get-user-settings","pageMetadata":{"title":"Get the authenticated user's settings","description":"Returns the authenticated user's profile (name, avatar, bio, location, age) and account settings (timezone, plan type).\n\n#### Response shape\n\n```json\n{\n \"user\": {\n \"name\": \"username\",\n \"joined_at\": \"2018-01-15T00:00:00Z\",\n \"gender\": \"Male\",\n \"avatar\": \"https://simkl.in/avatars/.../user_100.jpg\",\n \"bio\": \"I like anime.\",\n \"loc\": \"Spain\",\n \"age\": 28\n },\n \"account\": {\n \"id\": 12345,\n \"timezone\": \"Europe/Madrid\",\n \"type\": \"vip\"\n }\n}\n```\n\n`account.type` is one of `free`, `pro`, `vip`. Fields like `gender` are blank if the user disabled them in their privacy settings.\n\n#### When to refetch\n\nUser settings are **set-and-forget** in practice — most users configure their timezone / date format / privacy preferences once and never touch them again. **Don't refetch on a timer or on every app launch / wake from background.** Instead, gate the refetch on [`/sync/activities`](/api-reference/simkl/get-activities), which returns a `settings.all` timestamp that bumps when the user changes any account-level preference. Refetch only when that timestamp moves since the value you saved last time. Most launches will do **zero** extra calls. Full pattern + code example at [Dates and timezones → User timezone preference](/conventions/dates#user-timezone-preference).","deprecated":null,"version":null,"sidebarTitle":"User settings","openapi":"/openapi.json get /users/settings","href":"/api-reference/simkl/get-user-settings","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n a: \"a\",\n code: \"code\",\n h4: \"h4\",\n p: \"p\",\n pre: \"pre\",\n span: \"span\",\n strong: \"strong\",\n ..._provideComponents(),\n ...props.components\n }, {CodeBlock} = _components;\n if (!CodeBlock) _missingMdxReference(\"CodeBlock\", true);\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Returns the authenticated user’s profile (name, avatar, bio, location, age) and account settings (timezone, plan type).\"\n }), \"\\n\", _jsx(_components.h4, {\n children: \"Response shape\"\n }), \"\\n\", _jsx(CodeBlock, {\n numberOfLines: \"16\",\n language: \"json\",\n children: _jsx(_components.pre, {\n className: \"shiki shiki-themes github-light-default dark-plus\",\n style: {\n backgroundColor: \"#ffffff\",\n \"--shiki-dark-bg\": \"#0B0C0E\",\n color: \"#1f2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n language: \"json\",\n children: _jsxs(_components.code, {\n language: \"json\",\n numberOfLines: \"16\",\n children: [_jsx(_components.span, {\n className: \"line\",\n children: _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \"{\"\n })\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"#116329\",\n \"--shiki-dark\": \"#9CDCFE\"\n },\n children: \" \\\"user\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \": {\"\n })]\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"#116329\",\n \"--shiki-dark\": \"#9CDCFE\"\n },\n children: \" \\\"name\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \": \"\n }), _jsx(_components.span, {\n style: {\n color: \"#0A3069\",\n \"--shiki-dark\": \"#CE9178\"\n },\n children: \"\\\"username\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \",\"\n })]\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"#116329\",\n \"--shiki-dark\": \"#9CDCFE\"\n },\n children: \" \\\"joined_at\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \": \"\n }), _jsx(_components.span, {\n style: {\n color: \"#0A3069\",\n \"--shiki-dark\": \"#CE9178\"\n },\n children: \"\\\"2018-01-15T00:00:00Z\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \",\"\n })]\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"#116329\",\n \"--shiki-dark\": \"#9CDCFE\"\n },\n children: \" \\\"gender\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \": \"\n }), _jsx(_components.span, {\n style: {\n color: \"#0A3069\",\n \"--shiki-dark\": \"#CE9178\"\n },\n children: \"\\\"Male\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \",\"\n })]\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"#116329\",\n \"--shiki-dark\": \"#9CDCFE\"\n },\n children: \" \\\"avatar\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \": \"\n }), _jsx(_components.span, {\n style: {\n color: \"#0A3069\",\n \"--shiki-dark\": \"#CE9178\"\n },\n children: \"\\\"https://simkl.in/avatars/.../user_100.jpg\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \",\"\n })]\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"#116329\",\n \"--shiki-dark\": \"#9CDCFE\"\n },\n children: \" \\\"bio\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \": \"\n }), _jsx(_components.span, {\n style: {\n color: \"#0A3069\",\n \"--shiki-dark\": \"#CE9178\"\n },\n children: \"\\\"I like anime.\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \",\"\n })]\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"#116329\",\n \"--shiki-dark\": \"#9CDCFE\"\n },\n children: \" \\\"loc\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \": \"\n }), _jsx(_components.span, {\n style: {\n color: \"#0A3069\",\n \"--shiki-dark\": \"#CE9178\"\n },\n children: \"\\\"Spain\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \",\"\n })]\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"#116329\",\n \"--shiki-dark\": \"#9CDCFE\"\n },\n children: \" \\\"age\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \": \"\n }), _jsx(_components.span, {\n style: {\n color: \"#0550AE\",\n \"--shiki-dark\": \"#B5CEA8\"\n },\n children: \"28\"\n })]\n }), \"\\n\", _jsx(_components.span, {\n className: \"line\",\n children: _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \" },\"\n })\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"#116329\",\n \"--shiki-dark\": \"#9CDCFE\"\n },\n children: \" \\\"account\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \": {\"\n })]\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"#116329\",\n \"--shiki-dark\": \"#9CDCFE\"\n },\n children: \" \\\"id\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \": \"\n }), _jsx(_components.span, {\n style: {\n color: \"#0550AE\",\n \"--shiki-dark\": \"#B5CEA8\"\n },\n children: \"12345\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \",\"\n })]\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"#116329\",\n \"--shiki-dark\": \"#9CDCFE\"\n },\n children: \" \\\"timezone\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \": \"\n }), _jsx(_components.span, {\n style: {\n color: \"#0A3069\",\n \"--shiki-dark\": \"#CE9178\"\n },\n children: \"\\\"Europe/Madrid\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \",\"\n })]\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"#116329\",\n \"--shiki-dark\": \"#9CDCFE\"\n },\n children: \" \\\"type\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \": \"\n }), _jsx(_components.span, {\n style: {\n color: \"#0A3069\",\n \"--shiki-dark\": \"#CE9178\"\n },\n children: \"\\\"vip\\\"\"\n })]\n }), \"\\n\", _jsx(_components.span, {\n className: \"line\",\n children: _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \" }\"\n })\n }), \"\\n\", _jsx(_components.span, {\n className: \"line\",\n children: _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \"}\"\n })\n }), \"\\n\"]\n })\n })\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.code, {\n children: \"account.type\"\n }), \" is one of \", _jsx(_components.code, {\n children: \"free\"\n }), \", \", _jsx(_components.code, {\n children: \"pro\"\n }), \", \", _jsx(_components.code, {\n children: \"vip\"\n }), \". Fields like \", _jsx(_components.code, {\n children: \"gender\"\n }), \" are blank if the user disabled them in their privacy settings.\"]\n }), \"\\n\", _jsx(_components.h4, {\n children: \"When to refetch\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"User settings are \", _jsx(_components.strong, {\n children: \"set-and-forget\"\n }), \" in practice — most users configure their timezone / date format / privacy preferences once and never touch them again. \", _jsx(_components.strong, {\n children: \"Don’t refetch on a timer or on every app launch / wake from background.\"\n }), \" Instead, gate the refetch on \", _jsx(_components.a, {\n href: \"/api-reference/simkl/get-activities\",\n children: _jsx(_components.code, {\n children: \"/sync/activities\"\n })\n }), \", which returns a \", _jsx(_components.code, {\n children: \"settings.all\"\n }), \" timestamp that bumps when the user changes any account-level preference. Refetch only when that timestamp moves since the value you saved last time. Most launches will do \", _jsx(_components.strong, {\n children: \"zero\"\n }), \" extra calls. Full pattern + code example at \", _jsx(_components.a, {\n href: \"/conventions/dates#user-timezone-preference\",\n children: \"Dates and timezones → User timezone preference\"\n }), \".\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\nfunction _missingMdxReference(id, component) {\n throw new Error(\"Expected \" + (component ? \"component\" : \"object\") + \" `\" + id + \"` to be defined: you likely forgot to import, pass, or provide it.\");\n}\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"codeStyling":{"theme":{"light":"github-light","dark":"vesper"}},"config":{},"pageMetadata":{"title":"Get the authenticated user's settings","description":"Returns the authenticated user's profile (name, avatar, bio, location, age) and account settings (timezone, plan type).\n\n#### Response shape\n\n```json\n{\n \"user\": {\n \"name\": \"username\",\n \"joined_at\": \"2018-01-15T00:00:00Z\",\n \"gender\": \"Male\",\n \"avatar\": \"https://simkl.in/avatars/.../user_100.jpg\",\n \"bio\": \"I like anime.\",\n \"loc\": \"Spain\",\n \"age\": 28\n },\n \"account\": {\n \"id\": 12345,\n \"timezone\": \"Europe/Madrid\",\n \"type\": \"vip\"\n }\n}\n```\n\n`account.type` is one of `free`, `pro`, `vip`. Fields like `gender` are blank if the user disabled them in their privacy settings.\n\n#### When to refetch\n\nUser settings are **set-and-forget** in practice — most users configure their timezone / date format / privacy preferences once and never touch them again. **Don't refetch on a timer or on every app launch / wake from background.** Instead, gate the refetch on [`/sync/activities`](/api-reference/simkl/get-activities), which returns a `settings.all` timestamp that bumps when the user changes any account-level preference. Refetch only when that timestamp moves since the value you saved last time. Most launches will do **zero** extra calls. Full pattern + code example at [Dates and timezones → User timezone preference](/conventions/dates#user-timezone-preference).","deprecated":null,"version":null,"sidebarTitle":"User settings","openapi":"/openapi.json get /users/settings","href":"/api-reference/simkl/get-user-settings","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/andrewmasyk/c998d3ea10630993/scripts.js"],"openApiReferenceData":{"operation":{"operationId":"get-users-settings","summary":"Get the authenticated user's settings","description":"Returns the authenticated user's profile (name, avatar, bio, location, age) and account settings (timezone, plan type).\n\n#### Response shape\n\n```json\n{\n \"user\": {\n \"name\": \"username\",\n \"joined_at\": \"2018-01-15T00:00:00Z\",\n \"gender\": \"Male\",\n \"avatar\": \"https://simkl.in/avatars/.../user_100.jpg\",\n \"bio\": \"I like anime.\",\n \"loc\": \"Spain\",\n \"age\": 28\n },\n \"account\": {\n \"id\": 12345,\n \"timezone\": \"Europe/Madrid\",\n \"type\": \"vip\"\n }\n}\n```\n\n`account.type` is one of `free`, `pro`, `vip`. Fields like `gender` are blank if the user disabled them in their privacy settings.\n\n#### When to refetch\n\nUser settings are **set-and-forget** in practice — most users configure their timezone / date format / privacy preferences once and never touch them again. **Don't refetch on a timer or on every app launch / wake from background.** Instead, gate the refetch on [`/sync/activities`](/api-reference/simkl/get-activities), which returns a `settings.all` timestamp that bumps when the user changes any account-level preference. Refetch only when that timestamp moves since the value you saved last time. Most launches will do **zero** extra calls. Full pattern + code example at [Dates and timezones → User timezone preference](/conventions/dates#user-timezone-preference).","parameters":["f533d473-ff2c-4950-be95-de21794272cf","db23bf51-5984-47cb-a692-5033becb1a41","d630a88c-2ae3-43f5-b7a9-92b1603ac136","b5a66102-ae85-4996-9e0e-e2f75b3b4f8b"],"responses":{"200":"367323ee-266e-4222-8d6d-d9499f441966","401":"01f637d6-fb44-4eab-94e2-6ac5743cb85c","412":"79812db8-ee33-4290-a5b3-ca7d89a95de0","429":"8acb635b-0ee1-4830-8e3e-a23ed4312651","500":"cffef61b-4b0e-441a-b2df-cd8d11558b8b"},"tags":["Users"],"x-mint":{"href":"/api-reference/simkl/get-user-settings","metadata":{"sidebarTitle":"User settings"}},"security":["784e01fb-c8f8-419b-a05d-afff24091c2e","a2562521-4475-46dd-b8db-703e18305926"],"method":"get","type":"path","servers":["1ff7513b-7c65-431d-a68f-d379fa335309","23b65516-5008-4875-b78d-4bd0b879e4f4"],"path":"/users/settings","baseUrlOptions":["https://api.simkl.com","https://data.simkl.in"],"title":"Get the authenticated user's settings","codeSamples":[],"requestExampleLanguages":["bash","python","javascript","typescript","kotlin","swift","java","node","go","csharp","dotnet","php","ruby","powershell","c++","c"],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[]},"dependencies":{"parameters":{"f533d473-ff2c-4950-be95-de21794272cf":{"name":"client_id","in":"query","required":true,"description":"Your **`client_id`** from your [Simkl developer settings](https://simkl.com/settings/developer/). Required on every request.","schema":{"type":"string","isRequired":true,"description":"Your **`client_id`** from your [Simkl developer settings](https://simkl.com/settings/developer/). Required on every request.","uniqueKey":"","typeLabel":"string"},"example":"YOUR_CLIENT_ID"},"db23bf51-5984-47cb-a692-5033becb1a41":{"name":"app-name","in":"query","required":true,"description":"Short, lowercase identifier for your app (e.g. `plex-scrobbler`, `kodi-bridge`). Helps Simkl identify which apps are using the API.","schema":{"type":"string","isRequired":true,"description":"Short, lowercase identifier for your app (e.g. `plex-scrobbler`, `kodi-bridge`). Helps Simkl identify which apps are using the API.","uniqueKey":"","typeLabel":"string"},"example":"my-app"},"d630a88c-2ae3-43f5-b7a9-92b1603ac136":{"name":"app-version","in":"query","required":true,"description":"Your app's current version (e.g. `1.0`, `2.4.1`). Helps Simkl debug issues you report.","schema":{"type":"string","isRequired":true,"description":"Your app's current version (e.g. `1.0`, `2.4.1`). Helps Simkl debug issues you report.","uniqueKey":"","typeLabel":"string"},"example":"1.0"},"b5a66102-ae85-4996-9e0e-e2f75b3b4f8b":{"name":"User-Agent","in":"header","required":true,"description":"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)`.","schema":{"type":"string","isRequired":true,"description":"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)`.","uniqueKey":"","typeLabel":"string"},"example":"my-app/1.0"}},"responses":{"367323ee-266e-4222-8d6d-d9499f441966":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","description":"Authenticated user's profile and account settings.","properties":{"user":{"type":"object","properties":{"name":{"type":"string","uniqueKey":"user.name","typeLabel":"string"},"joined_at":{"type":"string","format":"date-time","uniqueKey":"user.joined_at","typeLabel":"string\u003cdate-time>"},"gender":{"type":"string","uniqueKey":"user.gender","typeLabel":"string"},"avatar":{"type":"string","format":"uri","uniqueKey":"user.avatar","typeLabel":"string\u003curi>"},"bio":{"type":"string","uniqueKey":"user.bio","typeLabel":"string"},"loc":{"oneOf":[{"type":"string","description":"Type 4 null — data not on file in that field's slot. See [Null and missing values](/conventions/null-values).","uniqueKey":"user.loc.oneOf.0","typeLabel":"string"},{"type":"null","description":"Type 4 null — data not on file in that field's slot. See [Null and missing values](/conventions/null-values).","uniqueKey":"user.loc.oneOf.1","typeLabel":"null"}],"uniqueKey":"user.loc","typeLabel":"string | null"},"age":{"type":"string","description":"Age in years, pre-formatted as a string like `\"30 years\"`. Empty string if the user has not set their birthday or has disabled age display. Pre-formatted by the server — clients should display verbatim rather than parsing.","example":"30 years","uniqueKey":"user.age","typeLabel":"string"}},"uniqueKey":"user","typeLabel":"object"},"account":{"type":"object","properties":{"id":{"type":"integer","uniqueKey":"account.id","typeLabel":"integer"},"timezone":{"type":"string","example":"Europe/Madrid","uniqueKey":"account.timezone","typeLabel":"string"},"type":{"type":"string","enum":["free","pro","vip"],"description":"Simkl account plan tier. `free` is the default; `pro` and `vip` are paid tiers that unlock higher rate limits and additional features. Some endpoints gate behavior on this value.","uniqueKey":"account.type","typeLabel":"enum\u003cstring>"},"anime_title_language":{"type":"string","enum":["en","romaji","native"],"description":"How the user prefers anime titles to be shown. `en` is the English title, `romaji` the transliterated Japanese, `native` the original Japanese. Honour it when rendering anime titles so your app matches what the user sees on simkl.com.","example":"en","uniqueKey":"account.anime_title_language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"account","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"user":{"name":"jane_doe","joined_at":"2018-06-12T14:23:08.000Z","gender":"female","avatar":"https://simkl.in/avatars/12/12345678abcdef9/user_100.jpg","bio":"Big into sci-fi shows and slice-of-life anime.","loc":"Lisbon, Portugal","age":"27 years"},"account":{"id":12345,"timezone":"Europe/Lisbon","type":"free","anime_title_language":"en"}},"examples":{"Example":{"title":"Example","value":{"user":{"name":"jane_doe","joined_at":"2018-06-12T14:23:08.000Z","gender":"female","avatar":"https://simkl.in/avatars/12/12345678abcdef9/user_100.jpg","bio":"Big into sci-fi shows and slice-of-life anime.","loc":"Lisbon, Portugal","age":"27 years"},"account":{"id":12345,"timezone":"Europe/Lisbon","type":"free","anime_title_language":"en"}}}},"exampleType":"examples"}},"exampleType":"examples"},"01f637d6-fb44-4eab-94e2-6ac5743cb85c":{"description":"Missing or invalid user access token. Provide a valid `Authorization: Bearer \u003caccess_token>` header.","content":{"application/json":{"schema":{"type":"object","description":"Standard error envelope for 4xx and 5xx responses. Branch on `error` (machine-readable identifier) — `message`, when present, is human-readable guidance and is **not stable across releases**.","properties":{"error":{"type":"string","description":"Machine-readable error identifier. Stable across responses — use this for programmatic branching in client code. Examples: `user_token_failed`, `client_id_failed`, `empty_field`, `wrong_parameter`, `id_err`, `rate_limit`.","example":"user_token_failed","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"integer","description":"HTTP status code echoed in the body for convenience — same value as the response status line. Always an integer.","example":401,"isRequired":true,"uniqueKey":"code","typeLabel":"integer"},"message":{"type":"string","description":"Human-readable error guidance. Optional — present on most errors, but not guaranteed. May reference the specific field or value that triggered the error. NOT stable; do not parse.","example":"Your client_id is wrong. Try another one","uniqueKey":"message","typeLabel":"string"}},"required":["error","code"],"uniqueKey":"","typeLabel":"object"},"example":{"error":"user_token_failed","code":401},"examples":{"Example":{"title":"Example","value":{"error":"user_token_failed","code":401}}},"exampleType":"examples"}},"exampleType":"examples"},"79812db8-ee33-4290-a5b3-ca7d89a95de0":{"description":"Your `client_id` is missing, wrong, disabled, or has hit a request limit. Verify in your [developer settings](https://simkl.com/settings/developer/).","content":{"application/json":{"schema":{"type":"object","description":"Standard error envelope for 4xx and 5xx responses. Branch on `error` (machine-readable identifier) — `message`, when present, is human-readable guidance and is **not stable across releases**.","properties":{"error":{"type":"string","description":"Machine-readable error identifier. Stable across responses — use this for programmatic branching in client code. Examples: `user_token_failed`, `client_id_failed`, `empty_field`, `wrong_parameter`, `id_err`, `rate_limit`.","example":"user_token_failed","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"integer","description":"HTTP status code echoed in the body for convenience — same value as the response status line. Always an integer.","example":401,"isRequired":true,"uniqueKey":"code","typeLabel":"integer"},"message":{"type":"string","description":"Human-readable error guidance. Optional — present on most errors, but not guaranteed. May reference the specific field or value that triggered the error. NOT stable; do not parse.","example":"Your client_id is wrong. Try another one","uniqueKey":"message","typeLabel":"string"}},"required":["error","code"],"uniqueKey":"","typeLabel":"object"},"example":{"error":"client_id_failed","code":412,"message":"Your client_id is wrong. Try another one"},"examples":{"Example":{"title":"Example","value":{"error":"client_id_failed","code":412,"message":"Your client_id is wrong. Try another one"}}},"exampleType":"examples"}},"exampleType":"examples"},"8acb635b-0ee1-4830-8e3e-a23ed4312651":{"description":"Too many requests in too short a window. Back off and retry with exponential backoff — see [Rate limits](/resources/rate-limits) for the playbook.","content":{"application/json":{"schema":{"type":"object","description":"Standard error envelope for 4xx and 5xx responses. Branch on `error` (machine-readable identifier) — `message`, when present, is human-readable guidance and is **not stable across releases**.","properties":{"error":{"type":"string","description":"Machine-readable error identifier. Stable across responses — use this for programmatic branching in client code. Examples: `user_token_failed`, `client_id_failed`, `empty_field`, `wrong_parameter`, `id_err`, `rate_limit`.","example":"user_token_failed","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"integer","description":"HTTP status code echoed in the body for convenience — same value as the response status line. Always an integer.","example":401,"isRequired":true,"uniqueKey":"code","typeLabel":"integer"},"message":{"type":"string","description":"Human-readable error guidance. Optional — present on most errors, but not guaranteed. May reference the specific field or value that triggered the error. NOT stable; do not parse.","example":"Your client_id is wrong. Try another one","uniqueKey":"message","typeLabel":"string"}},"required":["error","code"],"uniqueKey":"","typeLabel":"object"},"example":{"error":"rate_limit","code":429},"examples":{"Example":{"title":"Example","value":{"error":"rate_limit","code":429}}},"exampleType":"examples"}},"exampleType":"examples"},"cffef61b-4b0e-441a-b2df-cd8d11558b8b":{"description":"Something is broken on Simkl's side. Retry after a short delay. If it persists, report on the [Simkl Discord](https://discord.gg/MJsWNE4).","content":{"application/json":{"schema":{"type":"object","description":"Standard error envelope for 4xx and 5xx responses. Branch on `error` (machine-readable identifier) — `message`, when present, is human-readable guidance and is **not stable across releases**.","properties":{"error":{"type":"string","description":"Machine-readable error identifier. Stable across responses — use this for programmatic branching in client code. Examples: `user_token_failed`, `client_id_failed`, `empty_field`, `wrong_parameter`, `id_err`, `rate_limit`.","example":"user_token_failed","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"integer","description":"HTTP status code echoed in the body for convenience — same value as the response status line. Always an integer.","example":401,"isRequired":true,"uniqueKey":"code","typeLabel":"integer"},"message":{"type":"string","description":"Human-readable error guidance. Optional — present on most errors, but not guaranteed. May reference the specific field or value that triggered the error. NOT stable; do not parse.","example":"Your client_id is wrong. Try another one","uniqueKey":"message","typeLabel":"string"}},"required":["error","code"],"uniqueKey":"","typeLabel":"object"},"example":{"error":"internal","code":500},"examples":{"Example":{"title":"Example","value":{"error":"internal","code":500}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"784e01fb-c8f8-419b-a05d-afff24091c2e":{"clientId":{"type":"apiKey","in":"query","name":"client_id","description":"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](/conventions/headers).","x-default":"YOUR_CLIENT_ID","scopes":[],"schemeName":"clientId"},"bearerAuth":{"type":"http","scheme":"bearer","description":"A user `access_token`, sent as `Authorization: Bearer ...`. Required for endpoints that read or modify the user's library, scrobble session, ratings, settings, or playbacks. Every flow returns the same kind of token. See [Set up authentication](/api-reference/auth).","x-default":"YOUR_ACCESS_TOKEN","scopes":[],"schemeName":"bearerAuth"}},"a2562521-4475-46dd-b8db-703e18305926":{"simklApiKey":{"type":"apiKey","in":"header","name":"simkl-api-key","description":"Optional alias for the `client_id` query parameter. Simkl accepts your `client_id` either as the `simkl-api-key` request header **or** as the `?client_id=…` query parameter — pick one. The query-parameter form is preferred because it makes the request fully self-describing in URL form.","x-default":"YOUR_CLIENT_ID","scopes":[],"schemeName":"simklApiKey"},"bearerAuth":{"type":"http","scheme":"bearer","description":"A user `access_token`, sent as `Authorization: Bearer ...`. Required for endpoints that read or modify the user's library, scrobble session, ratings, settings, or playbacks. Every flow returns the same kind of token. See [Set up authentication](/api-reference/auth).","x-default":"YOUR_ACCESS_TOKEN","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"1ff7513b-7c65-431d-a68f-d379fa335309":{"url":"https://api.simkl.com","description":"Production API"},"23b65516-5008-4875-b78d-4bd0b879e4f4":{"url":"https://data.simkl.in","description":"CDN for static, public data files (Calendar + Trending). No auth required."}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"query","name":"client_id","description":"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](/conventions/headers).","x-default":"YOUR_CLIENT_ID","scopes":[],"schemeName":"clientId"},"schema":{"title":"client_id","type":"string","description":"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](/conventions/headers).","isRequired":true,"default":"YOUR_CLIENT_ID","typeLabel":"string","deprecated":false},"schemeName":"clientId","name":"client_id"},{"scheme":{"type":"http","scheme":"bearer","description":"A user `access_token`, sent as `Authorization: Bearer ...`. Required for endpoints that read or modify the user's library, scrobble session, ratings, settings, or playbacks. Every flow returns the same kind of token. See [Set up authentication](/api-reference/auth).","x-default":"YOUR_ACCESS_TOKEN","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"A user `access_token`, sent as `Authorization: Bearer ...`. Required for endpoints that read or modify the user's library, scrobble session, ratings, settings, or playbacks. Every flow returns the same kind of token. See [Set up authentication](/api-reference/auth).","format":"bearer","default":"YOUR_ACCESS_TOKEN","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"clientId \u0026 bearerAuth"},{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"simkl-api-key","description":"Optional alias for the `client_id` query parameter. Simkl accepts your `client_id` either as the `simkl-api-key` request header **or** as the `?client_id=…` query parameter — pick one. The query-parameter form is preferred because it makes the request fully self-describing in URL form.","x-default":"YOUR_CLIENT_ID","scopes":[],"schemeName":"simklApiKey"},"schema":{"title":"simkl-api-key","type":"string","description":"Optional alias for the `client_id` query parameter. Simkl accepts your `client_id` either as the `simkl-api-key` request header **or** as the `?client_id=…` query parameter — pick one. The query-parameter form is preferred because it makes the request fully self-describing in URL form.","isRequired":true,"default":"YOUR_CLIENT_ID","typeLabel":"string","deprecated":false},"schemeName":"simklApiKey","name":"simkl-api-key"},{"scheme":{"type":"http","scheme":"bearer","description":"A user `access_token`, sent as `Authorization: Bearer ...`. Required for endpoints that read or modify the user's library, scrobble session, ratings, settings, or playbacks. Every flow returns the same kind of token. See [Set up authentication](/api-reference/auth).","x-default":"YOUR_ACCESS_TOKEN","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"A user `access_token`, sent as `Authorization: Bearer ...`. Required for endpoints that read or modify the user's library, scrobble session, ratings, settings, or playbacks. Every flow returns the same kind of token. See [Set up authentication](/api-reference/auth).","format":"bearer","default":"YOUR_ACCESS_TOKEN","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"simklApiKey \u0026 bearerAuth"}]},"originalFileLocation":"openapi.json"},"subdomain":"andrewmasyk","siteName":"Simkl API","title":"Get the authenticated user's settings - Simkl API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-15T20:32:48.027Z","originalFileLocation":"api-reference/simkl/get-user-settings.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"dark\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Returns the authenticated user\u0026#x27;s profile (name, avatar, bio, location, age) and account settings (timezone, plan type). #### Response shape json { \u0026quot;user\u0026quot;: { \u0026quot;name\u0026quot;: \u0026quot;username\u0026quot;, \u0026quot;joined_at\u0026quot;: \u0026quot;2018-01-15T00:00:00Z\u0026quot;, \u0026quot;gender\u0026quot;: \u0026quot;Male\u0026quot;, \u0026quot;avatar\u0026quot;: \u0026quot;https://simkl.in/avatars/.../user_100.jpg\u0026quot;, \u0026quot;bio\u0026quot;: \u0026quot;I like anime.\u0026quot;, \u0026quot;loc\u0026quot;: \u0026quot;Spain\u0026quot;, \u0026quot;age\u0026quot;: 28 }, \u0026quot;account\u0026quot;: { \u0026quot;id\u0026quot;: 12345, \u0026quot;timezone\u0026quot;: \u0026quot;Europe/Madrid\u0026quot;, \u0026quot;type\u0026quot;: \u0026quot;vip\u0026quot; } } account.type is one of free, pro, vip. Fields like gender are blank if the user disabled them in their privacy settings. #### When to refetch User settings are set-and-forget in practice — most users configure their timezone / date format / privacy preferences once and never touch them again. Don\u0026#x27;t refetch on a timer or on every app launch / wake from background. Instead, gate the refetch on /sync/activities, which returns a settings.all timestamp that bumps when the user changes any account-level preference. Refetch only when that timestamp moves since the value you saved last time. Most launches will do zero extra calls. Full pattern + code example at Dates and timezones → User timezone preference.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Simkl API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/andrewmasyk/IyI3OjL228cw9rDC/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/andrewmasyk/IyI3OjL228cw9rDC/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/andrewmasyk/IyI3OjL228cw9rDC/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/andrewmasyk/IyI3OjL228cw9rDC/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/andrewmasyk/IyI3OjL228cw9rDC/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/andrewmasyk/IyI3OjL228cw9rDC/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/andrewmasyk/IyI3OjL228cw9rDC/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/andrewmasyk/IyI3OjL228cw9rDC/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/andrewmasyk/IyI3OjL228cw9rDC/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get the authenticated user\u0026#x27;s settings - Simkl API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns the authenticated user\u0026#x27;s profile (name, avatar, bio, location, age) and account settings (timezone, plan type). #### Response shape json { \u0026quot;user\u0026quot;: { \u0026quot;name\u0026quot;: \u0026quot;username\u0026quot;, \u0026quot;joined_at\u0026quot;: \u0026quot;2018-01-15T00:00:00Z\u0026quot;, \u0026quot;gender\u0026quot;: \u0026quot;Male\u0026quot;, \u0026quot;avatar\u0026quot;: \u0026quot;https://simkl.in/avatars/.../user_100.jpg\u0026quot;, \u0026quot;bio\u0026quot;: \u0026quot;I like anime.\u0026quot;, \u0026quot;loc\u0026quot;: \u0026quot;Spain\u0026quot;, \u0026quot;age\u0026quot;: 28 }, \u0026quot;account\u0026quot;: { \u0026quot;id\u0026quot;: 12345, \u0026quot;timezone\u0026quot;: \u0026quot;Europe/Madrid\u0026quot;, \u0026quot;type\u0026quot;: \u0026quot;vip\u0026quot; } } account.type is one of free, pro, vip. Fields like gender are blank if the user disabled them in their privacy settings. #### When to refetch User settings are set-and-forget in practice — most users configure their timezone / date format / privacy preferences once and never touch them again. Don\u0026#x27;t refetch on a timer or on every app launch / wake from background. Instead, gate the refetch on /sync/activities, which returns a settings.all timestamp that bumps when the user changes any account-level preference. Refetch only when that timestamp moves since the value you saved last time. Most launches will do zero extra calls. Full pattern + code example at Dates and timezones → User timezone preference.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Simkl API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://api.simkl.org/api-reference/simkl/get-user-settings\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://i.simkl.com/img_tv/apiary_logo_api.png\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get the authenticated user\u0026#x27;s settings - Simkl API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns the authenticated user\u0026#x27;s profile (name, avatar, bio, location, age) and account settings (timezone, plan type). #### Response shape json { \u0026quot;user\u0026quot;: { \u0026quot;name\u0026quot;: \u0026quot;username\u0026quot;, \u0026quot;joined_at\u0026quot;: \u0026quot;2018-01-15T00:00:00Z\u0026quot;, \u0026quot;gender\u0026quot;: \u0026quot;Male\u0026quot;, \u0026quot;avatar\u0026quot;: \u0026quot;https://simkl.in/avatars/.../user_100.jpg\u0026quot;, \u0026quot;bio\u0026quot;: \u0026quot;I like anime.\u0026quot;, \u0026quot;loc\u0026quot;: \u0026quot;Spain\u0026quot;, \u0026quot;age\u0026quot;: 28 }, \u0026quot;account\u0026quot;: { \u0026quot;id\u0026quot;: 12345, \u0026quot;timezone\u0026quot;: \u0026quot;Europe/Madrid\u0026quot;, \u0026quot;type\u0026quot;: \u0026quot;vip\u0026quot; } } account.type is one of free, pro, vip. Fields like gender are blank if the user disabled them in their privacy settings. #### When to refetch User settings are set-and-forget in practice — most users configure their timezone / date format / privacy preferences once and never touch them again. Don\u0026#x27;t refetch on a timer or on every app launch / wake from background. Instead, gate the refetch on /sync/activities, which returns a settings.all timestamp that bumps when the user changes any account-level preference. Refetch only when that timestamp moves since the value you saved last time. Most launches will do zero extra calls. Full pattern + code example at Dates and timezones → User timezone preference.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://i.simkl.com/img_tv/apiary_logo_api.png\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/andrewmasyk/IyI3OjL228cw9rDC/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Simkl API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#3B82F6\">\u003clink data-mint-head rel=\"canonical\" href=\"https://api.simkl.org/api-reference/simkl/get-user-settings\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/simkl/get-user-settings.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://api.simkl.org/#organization\",\"name\":\"Simkl API\",\"url\":\"https://api.simkl.org\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/andrewmasyk/yVND0Vg0vHbm_kqK/logo/light.svg?fit=max\u0026auto=format\u0026n=yVND0Vg0vHbm_kqK\u0026q=85\u0026s=3ed4c7fdfb9f19455db11c9a13dd466e\"}},{\"@type\":\"WebSite\",\"@id\":\"https://api.simkl.org#website\",\"name\":\"Simkl API\",\"url\":\"https://api.simkl.org\",\"publisher\":{\"@id\":\"https://api.simkl.org/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://api.simkl.org/api-reference/simkl/get-user-settings#webpage\",\"url\":\"https://api.simkl.org/api-reference/simkl/get-user-settings\",\"name\":\"Get the authenticated user's settings\",\"description\":\"Returns the authenticated user's profile (name, avatar, bio, location, age) and account settings (timezone, plan type). #### Response shape json { \\\"user\\\": { \\\"name\\\": \\\"username\\\", \\\"joined_at\\\": \\\"2018-01-15T00:00:00Z\\\", \\\"gender\\\": \\\"Male\\\", \\\"avatar\\\": \\\"https://simkl.in/avatars/.../user_100.jpg\\\", \\\"bio\\\": \\\"I like anime.\\\", \\\"loc\\\": \\\"Spain\\\", \\\"age\\\": 28 }, \\\"account\\\": { \\\"id\\\": 12345, \\\"timezone\\\": \\\"Europe/Madrid\\\", \\\"type\\\": \\\"vip\\\" } } account.type is one of free, pro, vip. Fields like gender are blank if the user disabled them in their privacy settings. #### When to refetch User settings are set-and-forget in practice — most users configure their timezone / date format / privacy preferences once and never touch them again. Don't refetch on a timer or on every app launch / wake from background. Instead, gate the refetch on /sync/activities, which returns a settings.all timestamp that bumps when the user changes any account-level preference. Refetch only when that timestamp moves since the value you saved last time. Most launches will do zero extra calls. Full pattern + code example at Dates and timezones → User timezone preference.\",\"dateModified\":\"2026-11-15T20:32:48.027Z\",\"isPartOf\":{\"@id\":\"https://api.simkl.org#website\"},\"breadcrumb\":{\"@id\":\"https://api.simkl.org/api-reference/simkl/get-user-settings#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://api.simkl.org/api-reference/simkl/get-user-settings#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Users\",\"item\":\"https://api.simkl.org/api-reference/users\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get the authenticated user's settings\",\"item\":\"https://api.simkl.org/api-reference/simkl/get-user-settings\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://api.simkl.org/api-reference/simkl/get-user-settings#apireference\",\"headline\":\"Get the authenticated user's settings\",\"name\":\"Get the authenticated user's settings\",\"description\":\"Returns the authenticated user's profile (name, avatar, bio, location, age) and account settings (timezone, plan type). #### Response shape json { \\\"user\\\": { \\\"name\\\": \\\"username\\\", \\\"joined_at\\\": \\\"2018-01-15T00:00:00Z\\\", \\\"gender\\\": \\\"Male\\\", \\\"avatar\\\": \\\"https://simkl.in/avatars/.../user_100.jpg\\\", \\\"bio\\\": \\\"I like anime.\\\", \\\"loc\\\": \\\"Spain\\\", \\\"age\\\": 28 }, \\\"account\\\": { \\\"id\\\": 12345, \\\"timezone\\\": \\\"Europe/Madrid\\\", \\\"type\\\": \\\"vip\\\" } } account.type is one of free, pro, vip. Fields like gender are blank if the user disabled them in their privacy settings. #### When to refetch User settings are set-and-forget in practice — most users configure their timezone / date format / privacy preferences once and never touch them again. Don't refetch on a timer or on every app launch / wake from background. Instead, gate the refetch on /sync/activities, which returns a settings.all timestamp that bumps when the user changes any account-level preference. Refetch only when that timestamp moves since the value you saved last time. Most launches will do zero extra calls. Full pattern + code example at Dates and timezones → User timezone preference.\",\"url\":\"https://api.simkl.org/api-reference/simkl/get-user-settings\",\"mainEntityOfPage\":{\"@id\":\"https://api.simkl.org/api-reference/simkl/get-user-settings#webpage\"},\"image\":\"https://i.simkl.com/img_tv/apiary_logo_api.png\",\"dateModified\":\"2026-11-15T20:32:48.027Z\",\"publisher\":{\"@id\":\"https://api.simkl.org/#organization\"},\"isPartOf\":{\"@id\":\"https://api.simkl.org#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Simkl API\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Simkl API\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/simkl/get-user-settings.md","siteName":"Simkl API","nav":{"global":{"anchors":[]},"tabs":[{"tab":"Documentation","icon":"book-open","align":"start","pages":[{"title":"Documentation","href":""}]},{"tab":"API Reference","icon":"code","align":"start","groups":[{"group":"API Reference","icon":"book-bookmark","pages":[{"title":"Introduction","sidebarTitle":"Introduction","icon":"circle-info","href":"/api-reference/introduction"},{"title":"Pagination","icon":"list-ol","href":"/conventions/pagination"},{"title":"Rate limits","icon":"gauge","href":"/resources/rate-limits"},{"title":"Errors and status codes","sidebarTitle":"Errors","icon":"triangle-exclamation","href":"/conventions/errors"}]},{"group":"Trending","icon":"fire","pages":[{"title":"Trending data files","sidebarTitle":"Trending","icon":"fire","href":"/api-reference/trending"}]},{"group":"Calendar","icon":"calendar","pages":[{"title":"Calendar data files","sidebarTitle":"Calendar","icon":"calendar","href":"/api-reference/calendar"}]},{"group":"Redirect","icon":"arrow-right","pages":[{"title":"Redirect \u0026 deep-linking","sidebarTitle":"About Redirect","icon":"circle-info","href":"/api-reference/redirect"},{"title":"Resolve any ID and redirect to Simkl","deprecated":null,"version":null,"sidebarTitle":"Redirect","openapi":"/openapi.json get /redirect","href":"/api-reference/simkl/redirect"}]},{"group":"Auth","icon":"shield-halved","pages":[{"title":"Set up authentication","sidebarTitle":"Set up auth","icon":"wrench","href":"/api-reference/auth"},{"group":"AUTH V2","icon":"shield-check","pages":[{"title":"AUTH V2 overview","sidebarTitle":"Overview","icon":"book-open","href":"/api-reference/auth-v2"},{"group":"OAuth","icon":"lock","pages":[{"title":"OAuth 2.0 flow (AUTH V2)","sidebarTitle":"Walkthrough","icon":"browser","href":"/api-reference/oauth2-authorization-code"},{"title":"PKCE in AUTH V2","sidebarTitle":"PKCE","icon":"shield-keyhole","href":"/api-reference/oauth2-pkce"},{"title":"Authorize (V2)","deprecated":null,"version":null,"sidebarTitle":"Authorize","playground":"simple","openapi":"/openapi.json get /oauth2/authorize","href":"/api-reference/simkl/oauth2-authorize"},{"title":"Token (V2)","deprecated":null,"version":null,"sidebarTitle":"Token (code, refresh, device)","openapi":"/openapi.json post /oauth2/token","href":"/api-reference/simkl/oauth2-token"}]},{"group":"Device / PIN","icon":"tv","pages":[{"title":"Device / PIN flow (AUTH V2)","sidebarTitle":"Walkthrough","icon":"qrcode","href":"/api-reference/oauth2-device"},{"title":"Device authorization (V2)","deprecated":null,"version":null,"sidebarTitle":"Request device code","openapi":"/openapi.json post /oauth2/device","href":"/api-reference/simkl/oauth2-device"}]},{"group":"Tokens \u0026 scopes","icon":"rotate","pages":[{"title":"Tokens and refresh (AUTH V2)","sidebarTitle":"Refreshing","icon":"key","href":"/api-reference/oauth2-tokens"},{"title":"Scopes (AUTH V2)","sidebarTitle":"Scopes","icon":"list-check","href":"/api-reference/oauth2-scopes"},{"title":"Revoke token (V2)","deprecated":null,"version":null,"sidebarTitle":"Revoke token","openapi":"/openapi.json post /oauth2/revoke","href":"/api-reference/simkl/oauth2-revoke"}]},{"title":"OAuth client libraries (AUTH V2)","sidebarTitle":"Client libraries","icon":"puzzle-piece","href":"/api-reference/oauth2-libraries"}]},{"group":"AUTH V1","icon":"clock-rotate-left","pages":[{"title":"AUTH V1 overview","sidebarTitle":"Overview","icon":"clock-rotate-left","href":"/api-reference/auth-v1"},{"title":"Public PKCE (AUTH V1)","sidebarTitle":"Public PKCE","icon":"shield-keyhole","href":"/api-reference/oauth-pkce"},{"group":"OAuth","icon":"lock","pages":[{"title":"OAuth flow (AUTH V1)","sidebarTitle":"OAuth flow","icon":"route","href":"/api-reference/oauth"},{"title":"Authorize a user","deprecated":null,"version":null,"sidebarTitle":"OAuth authorize","playground":"simple","openapi":"/openapi.json get /oauth/authorize","href":"/api-reference/simkl/authorize"},{"title":"Exchange an authorization code for an access token","deprecated":null,"version":null,"sidebarTitle":"OAuth token","openapi":"/openapi.json post /oauth/token","href":"/api-reference/simkl/exchange-token"}]},{"group":"Device / PIN","icon":"tv","pages":[{"title":"PIN flow (AUTH V1)","sidebarTitle":"PIN flow","icon":"route","href":"/api-reference/pin"},{"title":"Request a PIN code","deprecated":null,"version":null,"sidebarTitle":"Request PIN","openapi":"/openapi.json get /oauth/pin","href":"/api-reference/simkl/get-pin"},{"title":"Poll PIN code for the access token","deprecated":null,"version":null,"sidebarTitle":"Poll PIN","openapi":"/openapi.json get /oauth/pin/{user_code}","href":"/api-reference/simkl/check-pin"}]},{"title":"OAuth client libraries","sidebarTitle":"Client libraries","icon":"puzzle-piece","href":"/api-reference/oauth-libraries"}]}]},{"group":"Scrobble","icon":"play","pages":[{"title":"How scrobbling works","icon":"diagram-project","href":"/api-reference/scrobble"},{"title":"Check-in","deprecated":null,"version":null,"sidebarTitle":"Check-in","openapi":"/openapi.json post /scrobble/checkin","href":"/api-reference/simkl/scrobble-checkin"},{"title":"Pause","deprecated":null,"version":null,"sidebarTitle":"Pause","openapi":"/openapi.json post /scrobble/pause","href":"/api-reference/simkl/scrobble-pause"},{"title":"Start","deprecated":null,"version":null,"sidebarTitle":"Start","openapi":"/openapi.json post /scrobble/start","href":"/api-reference/simkl/scrobble-start"},{"title":"Stop","deprecated":null,"version":null,"sidebarTitle":"Stop","openapi":"/openapi.json post /scrobble/stop","href":"/api-reference/simkl/scrobble-stop"}]},{"group":"Playback","icon":"play-pause","pages":[{"title":"How playbacks work","icon":"play-pause","href":"/api-reference/playback"},{"title":"Get paused playback sessions for every type","deprecated":null,"version":null,"sidebarTitle":"Playback (all types)","openapi":"/openapi.json get /sync/playback","href":"/api-reference/simkl/get-playback-sessions-all"},{"title":"Get paused playback sessions for one type","deprecated":null,"version":null,"sidebarTitle":"Playback (by type)","openapi":"/openapi.json get /sync/playback/{type}","href":"/api-reference/simkl/get-playback-sessions"},{"title":"Delete Playback","deprecated":null,"version":null,"sidebarTitle":"Delete Playback","openapi":"/openapi.json delete /sync/playback/{id}","href":"/api-reference/simkl/delete-playback"}]},{"group":"Sync","icon":"arrows-rotate","pages":[{"title":"Sync","sidebarTitle":"Sync","icon":"diagram-project","href":"/api-reference/sync"},{"title":"Get Last Activities","deprecated":null,"version":null,"sidebarTitle":"Last Activities","openapi":"/openapi.json get /sync/activities","href":"/api-reference/simkl/get-activities"},{"title":"Add to Watchlist","deprecated":null,"version":null,"sidebarTitle":"Add to Watchlist","openapi":"/openapi.json post /sync/add-to-list","href":"/api-reference/simkl/add-to-list"},{"title":"Get all items of one type in one status bucket","deprecated":null,"version":null,"sidebarTitle":"All items","openapi":"/openapi.json get /sync/all-items/{type}/{status}","href":"/api-reference/simkl/get-all-items"},{"title":"Add to History","deprecated":null,"version":null,"sidebarTitle":"Add to History","openapi":"/openapi.json post /sync/history","href":"/api-reference/simkl/add-to-history"},{"title":"Remove from History","deprecated":null,"version":null,"sidebarTitle":"Remove from History","openapi":"/openapi.json post /sync/history/remove","href":"/api-reference/simkl/remove-from-history"},{"title":"Add Ratings","deprecated":null,"version":null,"sidebarTitle":"Add Ratings","openapi":"/openapi.json post /sync/ratings","href":"/api-reference/simkl/add-ratings"},{"title":"Remove Ratings","deprecated":null,"version":null,"sidebarTitle":"Remove Ratings","openapi":"/openapi.json post /sync/ratings/remove","href":"/api-reference/simkl/remove-ratings"},{"title":"Get the user's rated items, filtered by type and rating","deprecated":null,"version":null,"sidebarTitle":"User ratings","openapi":"/openapi.json get /sync/ratings/{type}/{rating}","href":"/api-reference/simkl/get-user-ratings"},{"title":"Look up watched status for items","deprecated":null,"version":null,"sidebarTitle":"Lookup watched","openapi":"/openapi.json post /sync/watched","href":"/api-reference/simkl/get-watched"}]},{"group":"Custom Lists","icon":"list","pages":[{"title":"Custom lists","sidebarTitle":"Overview","icon":"list","href":"/api-reference/lists"},{"title":"Get a custom list","deprecated":null,"version":null,"sidebarTitle":"Get custom list","openapi":"/openapi.json get /lists/{id}","href":"/api-reference/simkl/get-list"},{"title":"Get a user's custom lists","deprecated":null,"version":null,"sidebarTitle":"Get user's custom lists","openapi":"/openapi.json get /lists/user/{userId}","href":"/api-reference/simkl/get-user-lists"},{"title":"Create a custom list","deprecated":null,"version":null,"sidebarTitle":"Create custom list","openapi":"/openapi.json post /lists","href":"/api-reference/simkl/create-list"},{"title":"Edit a custom list","deprecated":null,"version":null,"sidebarTitle":"Edit custom list","openapi":"/openapi.json post /lists/{id}","href":"/api-reference/simkl/update-list"},{"title":"Delete a custom list","deprecated":null,"version":null,"sidebarTitle":"Delete custom list","openapi":"/openapi.json delete /lists/{id}","href":"/api-reference/simkl/delete-list"},{"title":"Add or reorder titles in a custom list","deprecated":null,"version":null,"sidebarTitle":"Add list items","openapi":"/openapi.json post /lists/{id}/items","href":"/api-reference/simkl/add-list-items"},{"title":"Remove titles from a custom list","deprecated":null,"version":null,"sidebarTitle":"Remove list items","openapi":"/openapi.json post /lists/{id}/items/remove","href":"/api-reference/simkl/remove-list-items"},{"title":"Add favorites","deprecated":null,"version":null,"sidebarTitle":"Add favorites","openapi":"/openapi.json post /lists/favorites","href":"/api-reference/simkl/add-favorites"},{"title":"Remove favorites","deprecated":null,"version":null,"sidebarTitle":"Remove favorites","openapi":"/openapi.json post /lists/favorites/remove","href":"/api-reference/simkl/remove-favorites"}]},{"group":"Search","icon":"magnifying-glass","pages":[{"title":"About Search","icon":"circle-info","href":"/api-reference/search"},{"title":"Find an item by file name","deprecated":null,"version":null,"sidebarTitle":"By file","openapi":"/openapi.json post /search/file","href":"/api-reference/simkl/search-by-file"},{"title":"Find items by external ID","deprecated":null,"version":null,"sidebarTitle":"By ID","openapi":"/openapi.json get /search/id","href":"/api-reference/simkl/search-by-id"},{"title":"Random pick","deprecated":null,"version":null,"sidebarTitle":"Random","openapi":"/openapi.json post /search/random","href":"/api-reference/simkl/search-random"},{"title":"Search by text query","deprecated":null,"version":null,"sidebarTitle":"By text","openapi":"/openapi.json get /search/{type}","href":"/api-reference/simkl/search-by-text"}]},{"group":"TV","icon":"tv","pages":[{"title":"About TV","icon":"circle-info","href":"/api-reference/tv"},{"group":"Look up a show","icon":"magnifying-glass","pages":[{"title":"TV show details","deprecated":null,"version":null,"sidebarTitle":"TV details","openapi":"/openapi.json get /tv/{id}","href":"/api-reference/simkl/get-tv-show"},{"title":"List episodes for a TV show","deprecated":null,"version":null,"sidebarTitle":"TV episodes","openapi":"/openapi.json get /tv/episodes/{id}","href":"/api-reference/simkl/get-tv-episodes"}]},{"group":"Browse \u0026 discover","icon":"compass","pages":[{"title":"TV shows airing today, tomorrow, or on a specific date","deprecated":null,"version":null,"sidebarTitle":"Airing TV","openapi":"/openapi.json get /tv/airing","href":"/api-reference/simkl/get-tv-airing"},{"title":"TV premieres (new + upcoming)","deprecated":null,"version":null,"sidebarTitle":"Premieres","openapi":"/openapi.json get /tv/premieres/{param}","href":"/api-reference/simkl/get-tv-premieres"},{"title":"Top-rated TV shows","deprecated":null,"version":null,"sidebarTitle":"Best of","openapi":"/openapi.json get /tv/best/{filter}","href":"/api-reference/simkl/get-best-tv"},{"title":"TV by genre","deprecated":null,"version":null,"sidebarTitle":"Genres","openapi":"/openapi.json get /tv/genres/{genre}/{type}/{country}/{network}/{year}/{sort}","href":"/api-reference/simkl/get-tv-genres"}]},{"title":"Trending data files","sidebarTitle":"Trending","icon":"fire","href":"/api-reference/trending"},{"title":"Calendar data files","sidebarTitle":"Calendar","icon":"calendar","href":"/api-reference/calendar"}]},{"group":"Anime","icon":"dragon","pages":[{"title":"About Anime","icon":"circle-info","href":"/api-reference/anime"},{"group":"Look up an anime","icon":"magnifying-glass","pages":[{"title":"Anime details","deprecated":null,"version":null,"sidebarTitle":"Anime details","openapi":"/openapi.json get /anime/{id}","href":"/api-reference/simkl/get-anime"},{"title":"List episodes for an anime","deprecated":null,"version":null,"sidebarTitle":"Anime episodes","openapi":"/openapi.json get /anime/episodes/{id}","href":"/api-reference/simkl/get-anime-episodes"}]},{"group":"Browse \u0026 discover","icon":"compass","pages":[{"title":"Anime airing today, tomorrow, or on a specific date","deprecated":null,"version":null,"sidebarTitle":"Airing anime","openapi":"/openapi.json get /anime/airing","href":"/api-reference/simkl/get-anime-airing"},{"title":"Anime premieres (new + upcoming)","deprecated":null,"version":null,"sidebarTitle":"Premieres","openapi":"/openapi.json get /anime/premieres/{param}","href":"/api-reference/simkl/get-anime-premieres"},{"title":"Top-rated anime","deprecated":null,"version":null,"sidebarTitle":"Best of","openapi":"/openapi.json get /anime/best/{filter}","href":"/api-reference/simkl/get-best-anime"},{"title":"Anime by genre","deprecated":null,"version":null,"sidebarTitle":"Genres","openapi":"/openapi.json get /anime/genres/{genre}/{type}/{network}/{year}/{sort}","href":"/api-reference/simkl/get-anime-genres"}]},{"title":"Trending data files","sidebarTitle":"Trending","icon":"fire","href":"/api-reference/trending"},{"title":"Calendar data files","sidebarTitle":"Calendar","icon":"calendar","href":"/api-reference/calendar"}]},{"group":"Movies","icon":"film","pages":[{"title":"About Movies","icon":"circle-info","href":"/api-reference/movies"},{"title":"Movie details","deprecated":null,"version":null,"sidebarTitle":"Movie details","openapi":"/openapi.json get /movies/{id}","href":"/api-reference/simkl/get-movie"},{"title":"Movies by genre","deprecated":null,"version":null,"sidebarTitle":"Genres","openapi":"/openapi.json get /movies/genres/{genre}/{type}/{country}/{year}/{sort}","href":"/api-reference/simkl/get-movies-genres"},{"title":"Trending data files","sidebarTitle":"Trending","icon":"fire","href":"/api-reference/trending"},{"title":"Calendar data files","sidebarTitle":"Calendar","icon":"calendar","href":"/api-reference/calendar"}]},{"group":"Ratings","icon":"star","pages":[{"title":"About Ratings","icon":"circle-info","href":"/api-reference/ratings"},{"title":"Community ratings for items in the user's watchlist","deprecated":null,"version":null,"sidebarTitle":"Watchlist ratings","openapi":"/openapi.json get /ratings/{type}","href":"/api-reference/simkl/get-watchlist-ratings"}]},{"group":"Users","icon":"user","pages":[{"title":"About Users","icon":"circle-info","href":"/api-reference/users"},{"title":"Redirect to a user's last-watched cover image","description":"Pulls metadata about the user's most recently watched item — useful for \"Now Watching\" widgets, dashboard backgrounds, and embedded user-cards.\n\nNo `access_token` needed on AUTH V1 — just your `client_id`. **AUTH V2 apps must send the user's token** — an anonymous call returns `401 user_token_required`. See [AUTH V2 overview](/api-reference/auth-v2). The target user's profile must be public; private profiles return `404`.\n\n#### Two response modes (selected by the `image` query param)\n\n| `image` | Status | Body | Use case |\n|---|---|---|---|\n| _omitted_ | `200` | JSON with `id`, `url`, `title`, `poster`, `fanart` | Server-side render or custom card layout |\n| `poster` | `302` | Empty; `Location: https://simkl.net/posters/\u003ckey>_0.jpg` | Drop the request URL straight into `\u003cimg src=…>` |\n| `fanart` | `302` | Empty; `Location: https://simkl.net/fanart/\u003ckey>_0.jpg` | Same — full-bleed background image |\n\n#### Drop-in `\u003cimg>` example\n\nThe `?image=` redirect modes are designed for `\u003cimg src=\"…\">` tags. The browser follows the 302 automatically and renders the JPG — no JSON parsing, no string concatenation, no extra requests:\n\n```html\n\u003c!-- Background image (1920×1080-ish) -->\n\u003cimg src=\"https://api.simkl.com/users/recently-watched-background/12345?image=fanart\u0026client_id=YOUR_CLIENT_ID\u0026app-name=my-app-name\u0026app-version=1.0\">\n\n\u003c!-- Cover poster (vertical) -->\n\u003cimg src=\"https://api.simkl.com/users/recently-watched-background/12345?image=poster\u0026client_id=YOUR_CLIENT_ID\u0026app-name=my-app-name\u0026app-version=1.0\">\n```\n\n#### JSON mode shape\n\nThe no-param mode returns the same image keys as the redirect modes — concatenate manually if you want to skip the second round-trip:\n\n```json\n{\n \"id\": 17465,\n \"url\": \"https://simkl.com/tv/17465/game-of-thrones\",\n \"title\": \"Game of Thrones\",\n \"poster\": \"17/17465posterkey\",\n \"fanart\": \"17/17465fanartkey\"\n}\n```\n\nRender as `https://simkl.net/posters/\u003cposter>_0.jpg` / `https://simkl.net/fanart/\u003cfanart>_0.jpg`.","deprecated":null,"version":null,"sidebarTitle":"Cover image","openapi":"/openapi.json get /users/recently-watched-background/{user_id}","href":"/api-reference/simkl/get-recently-watched-image"},{"title":"Get the authenticated user's settings","deprecated":null,"version":null,"sidebarTitle":"User settings","openapi":"/openapi.json get /users/settings","href":"/api-reference/simkl/get-user-settings"},{"title":"Get a user's watch statistics","description":"\u003cWarning>\n**The most expensive call in the Simkl API. Only fire it on an explicit user action.**\n\nStats are computed **live on every request** — there is no edge cache and no precomputed result cache. The server walks the user's entire watch history across all three catalogs (movies, TV, anime), looks up the runtime of every completed episode and movie, and aggregates everything from scratch. Response time scales with the size of the user's library.\n\n**OK to call:** when the user opens a \"My stats\" / \"Year in review\" / profile screen, or taps a refresh button on a stats widget.\n\n**Do not call:** on app launch, on resume from background, in any polling loop, speculatively to \"warm\" data, or for every user in a list (e.g. a friends leaderboard — batch via lazy loading). Apps that hammer this endpoint risk rate-limit throttling on the `client_id`.\n\u003c/Warning>\n\nReturns aggregate stats for the given user — total movies / shows / anime watched, total time spent, episode counts and last-week activity.\n\nThe `user_id` must be a **positive integer** — the numeric Simkl id of the target account. To fetch stats for the **authenticated user**, call [`GET /users/settings`](/api-reference/simkl/get-user-settings) once at app start and cache `account.id`, then pass that value here.\n\nPublic profiles can be fetched without a bearer token (clientId-only). Private profiles require either a bearer token belonging to the target user, or a connection the target user has granted the requester (otherwise `403 private_profile`).\n\n#### Response shape\n\n```json\n{\n \"total_mins\": 78230,\n \"movies\": {\n \"total_mins\": 18000,\n \"plantowatch\": { \"mins\": 0, \"count\": 12 },\n \"completed\": { \"mins\": 18000, \"count\": 200 },\n \"dropped\": { \"mins\": 0, \"count\": 1 }\n },\n \"tv\": {\n \"total_mins\": 35000,\n \"watching\": { \"watched_episodes_count\": 23, \"count\": 4, \"left_to_watch_episodes\": 12, \"left_to_watch_mins\": 600, \"total_episodes_count\": 35 }\n },\n \"anime\": {... },\n \"watched_last_week\": { \"total_mins\": 320, \"movies_mins\": 60, \"tv_mins\": 200, \"anime_mins\": 60 }\n}\n```\n\n#### Errors\n\n| Code | When |\n|---|---|\n| `404 user_id_failed` | `user_id` is `0` or any non-positive integer. There is **no shortcut** for the authenticated user — always pass a real numeric id. |\n| `403 private_profile` | The target user's profile is private and the requester does not have access. |","deprecated":null,"version":null,"sidebarTitle":"User stats","openapi":"/openapi.json get /users/{user_id}/stats","href":"/api-reference/simkl/get-user-stats"}]},{"group":"Changes","icon":"code-compare","pages":[{"title":"Recently changed catalog items","deprecated":null,"version":null,"sidebarTitle":"Recent changes","openapi":"/openapi.json get /changes","href":"/api-reference/simkl/get-changes"}]}]},{"tab":"Changelog","icon":"clock-rotate-left","align":"start","pages":[{"title":"Changelog","href":"/changelog"}]}]},"basePath":"","title":"Get the authenticated user's settings - Simkl API","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-CiUHMMOm.js","snippetPresets-BgfXU7Bw.js","utils-DWvOwgy_.js","style-to-object-BY3JEAdk.js","utils-BN7RXSMJ.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-CFw8bq89.js","conditional-requirements-CFM0id0Q.js","cloneDeep-CAwdfOU2.js","_Uint8Array-BJr8e-ZL.js","isObject-FP1Yky1u.js","Page-CVJ-f_k1.js","CodeSnippet-D_HwgQO_.js","DynamicMarkdown-CQM9Bhbv.js","SectionHeading-DpbrP8nQ.js","icon-BPCgijHy.js","ApiExamples-XX0UgMZK.js","usePlaygroundInputsStore-DXDFSa1V.js","shallow-CdX5aREi.js","isEqual-CoOaxexF.js","CodeSnippets-Cg2wpzWm.js","getApiPlaygroundDisplay-CmCoerhe.js","MethodPill-GQ8DuY0c.js","getPastedJson-Cb5mT31m.js","Check2Icon-a7bUI6e8.js","axios-CsQoIw0U.js","Markdown-CX2QY19L.js","AssistantPageLink-CY3bFglh.js","dist-Dl6_zDnT.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}