{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-docs/api-reference/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["api-container","api-content","endpoint","api-examples","tabs","tab","code-group"]},"redocly_category":"API Reference","searchWeight":120,"type":"markdown"},"seo":{"title":"Get vocabulary settings","description":"Complete API reference and documentation for Freddy AI-powered backend system by Aitronos","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"get-vocabulary-settings","__idx":0},"children":["Get vocabulary settings"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The organization's vocabulary settings. Every member who manages a private vocabulary may read them; ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["editable"]}," says whether the caller may change them."]},{"$$mdtype":"Tag","name":"ApiContainer","attributes":{},"children":[{"$$mdtype":"Tag","name":"ApiContent","attributes":{},"children":[{"$$mdtype":"Tag","name":"Endpoint","attributes":{"method":"GET","path":"https://api.aitronos.com/v1/vocabulary/settings"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"returns","__idx":1},"children":["Returns"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The vocabulary settings:"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["learn_from_corrections"]}]}," boolean"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Whether a person's corrections teach their own private vocabulary."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["learned_sharing_mode"]}]}," string"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["How words several colleagues taught reach the shared list: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["approval"]}," (an administrator approves each) or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["automatic"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["share_threshold"]}]}," integer"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["How many colleagues must have taught a word before it is proposed for the shared list."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["shared_target_list_id"]}]}," string"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The list shared words go to; the organization list unless another list was chosen."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["suggestions_enabled"]}]}," boolean"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Whether suggestions are collected."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["automatic_state"]}]}," string"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["off"]}," in approval mode; ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["active"]},", or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["paused"]}," when automatic sharing stopped by itself."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["automatic_paused_reason"]}]}," string or null"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Why automatic sharing is paused, when it is."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["revision"]}]}," integer"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The settings revision; send it back as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["expected_revision"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["editable"]}]}," boolean"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Whether the caller may change the settings."]}]},{"$$mdtype":"Tag","name":"ApiExamples","attributes":{},"children":[{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"div","attributes":{"label":"Example","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeGroup","attributes":{"mode":"dropdown"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","data-title":"cURL","header":{"title":"cURL","controls":{"copy":{}}},"source":"curl -X GET \"https://api.aitronos.com/v1/vocabulary/settings\" \\\n  -H \"X-API-Key: $FREDDY_API_KEY\"\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"python","data-title":"Python","header":{"title":"Python","controls":{"copy":{}}},"source":"import os\nimport requests\n\napi_key = os.environ[\"FREDDY_API_KEY\"]\n\nresponse = requests.get(\n    \"https://api.aitronos.com/v1/vocabulary/settings\",\n    headers={\"X-API-Key\": api_key},\n)\n\nprint(response.json())\n","lang":"python"},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","data-title":"JavaScript","header":{"title":"JavaScript","controls":{"copy":{}}},"source":"const apiKey = process.env.FREDDY_API_KEY;\n\nconst response = await fetch('https://api.aitronos.com/v1/vocabulary/settings', {\n  method: 'GET',\n  headers: {\n    'X-API-Key': apiKey\n  }\n});\n\nconst data = await response.json();\nconsole.log(data);\n","lang":"javascript"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Response:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","data-title":"200 OK","header":{"title":"200 OK","controls":{"copy":{}}},"source":"{\n  \"learn_from_corrections\": true,\n  \"learned_sharing_mode\": \"approval\",\n  \"share_threshold\": 3,\n  \"shared_target_list_id\": \"voclist_1b7d5e9f3a2c4680\",\n  \"suggestions_enabled\": true,\n  \"automatic_state\": \"off\",\n  \"automatic_paused_reason\": null,\n  \"revision\": 4,\n  \"editable\": false\n}\n","lang":"json"},"children":[]}]},{"$$mdtype":"Tag","name":"div","attributes":{"label":"Errors","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","data-title":"401 Unauthorized","header":{"title":"401 Unauthorized","controls":{"copy":{}}},"source":"{\n  \"success\": false,\n  \"error\": {\n    \"code\": \"AUTHENTICATION_REQUIRED\",\n    \"message\": \"Authentication required. Please provide a valid API key.\",\n    \"system_message\": \"Missing or invalid authorization header\",\n    \"type\": \"authentication_error\",\n    \"status\": 401,\n    \"details\": {},\n    \"trace_id\": \"req_7d1e4b9a2c\",\n    \"timestamp\": \"2026-10-24T09:30:00Z\"\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","data-title":"403 Forbidden","header":{"title":"403 Forbidden","controls":{"copy":{}}},"source":"{\n  \"success\": false,\n  \"error\": {\n    \"code\": \"INSUFFICIENT_PERMISSIONS\",\n    \"message\": \"You do not have permission to perform this action.\",\n    \"system_message\": \"Caller lacks the rights this operation needs.\",\n    \"type\": \"authorization_error\",\n    \"status\": 403,\n    \"details\": {},\n    \"trace_id\": \"req_7d1e4b9a2c\",\n    \"timestamp\": \"2026-10-24T09:30:00Z\"\n  }\n}\n","lang":"json"},"children":[]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"related-resources","__idx":2},"children":["Related Resources"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api-reference/vocabulary/_index"},"children":["Vocabulary API"]}," — Overview of lists, entries and settings."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api-reference/access-control/create-grant"},"children":["Create an access grant"]}," — Share a vocabulary list with people, teams or the whole organization."]}]}]},"headings":[{"value":"Get vocabulary settings","id":"get-vocabulary-settings","depth":1},{"value":"Returns","id":"returns","depth":2},{"value":"Related Resources","id":"related-resources","depth":2}],"frontmatter":{"title":"Get vocabulary settings","keywords":["get vocabulary settings","get","get","vocabulary","settings"],"seo":{"title":"Get vocabulary settings"}},"lastModified":"2026-10-25T12:39:00.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/docs/api-reference/vocabulary/get-vocabulary-settings","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}