Returns the full settings object for the specified application install, including configuration options such as facial processing, proctor types, exam notes, and more.
A valid authentication token must be provided in the token header.
GET
/
v1
/
installs
/
{installSid}
/
settings
Get Settings
curl --request GET \ --url https://api.smarterproctoring.com/v1/installs/{installSid}/settings \ --header 'token: <api-key>'
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"SmarterServices Platform","colors":{"primary":"#015692","light":"#0D9373","dark":"#015692"},"logo":{"light":"https://cdn.prod.website-files.com/650b016f7e13a7d9de337f22/6629053ca1393100c09aa484_SmarterServices%20Logo.png","dark":"https://cdn.prod.website-files.com/650b016f7e13a7d9de337f22/6629053ca1393100c09aa484_SmarterServices%20Logo.png"},"favicon":"https://mintcdn.com/smarterservicesllc/fCrC3qjG9fnKrDR3/favicon.png?fit=max\u0026auto=format\u0026n=fCrC3qjG9fnKrDR3\u0026q=85\u0026s=4ebd4e7b2756068bf227df06619633a6","api":{"openapi":["https://api.smarterproctoring.com/openapi.json","assessment/api/openapi.json"]},"navbar":{"links":[{"href":"https://intercom.help/smarterservices-llc-028a8a0949b6/en","label":"Support"}]},"footer":{"socials":{"website":"https://www.smarterservices.com","youtube":"https://www.youtube.com/@smarterservices","linkedin":"https://www.linkedin.com/company/smarterservices","facebook":"https://www.facebook.com/smarterservices","x":"https://x.com/smarterservices","github":"https://github.com/smarterservices"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"smarterservicesllc","hasAudioNarration":false,"actualSubdomain":"smarterservicesllc","customDomains":["developers.smarterservices.com"],"gitSource":{"type":"github","owner":"smarterservices","repo":"platform-documenation","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a5de60074e183eea51381f1","collectionId":"b4811552-fb4e-467d-88a2-623c3838f2d6","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6a5de60074e183eea51381f1"},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6a5de60074e183eea51381f1:success","clientVersion":"0.0.4044","searchFilterCounts":[{"language":"default","tag":"Proctoring","count":70},{"language":"default","tag":"Endpoints","count":63},{"language":"default","tag":"Platform","count":33},{"language":"default","tag":"BlockKit","count":25},{"language":"default","tag":"Reports","count":17},{"language":"default","tag":"Assessment","count":16},{"language":"default","tag":"API Reference","count":13},{"language":"default","tag":"SmarterElements","count":10},{"language":"default","tag":"Security \u0026 Authorization","count":9},{"language":"default","tag":"Getting Started","count":8}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","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":"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":"llms-txt-v2","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":"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":"byok-sep-25","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":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","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":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":".elements-example{border:1px solid #ddd;border-radius:var(--rounded-2xl, 1rem);overflow-y:auto;padding:5px}"}],"page":{"pagePath":"api-reference/app-install/get-settings","slug":"/api-reference/app-install/get-settings","pageMetadata":{"title":"Get Settings","description":"Returns the full settings object for the specified application install, including configuration options such as facial processing, proctor types, exam notes, and more.\u003cbr/>\u003cbr/>A valid authentication token must be provided in the `token` header.","deprecated":null,"version":null,"openapi":"https://api.dev.smarterproctoring.com/openapi.json get /v1/installs/{installSid}/settings","href":"/api-reference/app-install/get-settings","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Returns the full settings object for the specified application install, including configuration options such as facial processing, proctor types, exam notes, and more.\", _jsx(\"br\", {}), _jsx(\"br\", {}), \"A valid authentication token must be provided in the \", _jsx(_components.code, {\n children: \"token\"\n }), \" header.\"]\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};\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":{"config":{},"pageMetadata":{"title":"Get Settings","description":"Returns the full settings object for the specified application install, including configuration options such as facial processing, proctor types, exam notes, and more.\u003cbr/>\u003cbr/>A valid authentication token must be provided in the `token` header.","deprecated":null,"version":null,"openapi":"https://api.dev.smarterproctoring.com/openapi.json get /v1/installs/{installSid}/settings","href":"/api-reference/app-install/get-settings","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Get Settings","operationId":"getV1InstallsInstallsidSettings","description":"Returns the full settings object for the specified application install, including configuration options such as facial processing, proctor types, exam notes, and more.\u003cbr/>\u003cbr/>A valid authentication token must be provided in the `token` header.","parameters":["ba4d5fb5-03be-4e5d-abd4-b8c489078324"],"tags":["App Install"],"responses":{"200":"c98c28b7-b209-43ea-9c34-08a68630c564"},"method":"get","type":"path","servers":["c467fe82-756a-4d57-b25d-3f157236095f"],"security":["50c732bb-63a6-49e0-92e3-b6ebed732934"],"path":"/v1/installs/{installSid}/settings","baseUrlOptions":["https://api.smarterproctoring.com"],"title":"Get Settings","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"ba4d5fb5-03be-4e5d-abd4-b8c489078324":{"name":"installSid","in":"path","schema":{"type":"string","description":"Unique SID of the application install. Must match the pattern `AI` followed by 32 hex characters.","example":"AI1234567890abcdef1234567890abcdef","pattern":"^AI[a-f0-9]{32}$","isRequired":true,"uniqueKey":"","typeLabel":"string"},"description":"Unique SID of the application install. Must match the pattern `AI` followed by 32 hex characters.","required":true}},"responses":{"c98c28b7-b209-43ea-9c34-08a68630c564":{"description":"Successful","content":{"application/json":{"schema":{"type":"object","properties":{"sid":{"oneOf":[{"type":"string","description":"Install SID","uniqueKey":"sid.oneOf.0","typeLabel":"string"},{"type":"null","description":"Install SID","uniqueKey":"sid.oneOf.1","typeLabel":"null"}],"uniqueKey":"sid","typeLabel":"string | null"},"deploymentSid":{"oneOf":[{"type":"string","description":"Deployment SID","uniqueKey":"deploymentSid.oneOf.0","typeLabel":"string"},{"type":"null","description":"Deployment SID","uniqueKey":"deploymentSid.oneOf.1","typeLabel":"null"}],"uniqueKey":"deploymentSid","typeLabel":"string | null"},"applicationSid":{"oneOf":[{"type":"string","description":"Application SID","uniqueKey":"applicationSid.oneOf.0","typeLabel":"string"},{"type":"null","description":"Application SID","uniqueKey":"applicationSid.oneOf.1","typeLabel":"null"}],"uniqueKey":"applicationSid","typeLabel":"string | null"},"defaultCourseOfferingSid":{"oneOf":[{"type":"string","description":"Default course offering SID","uniqueKey":"defaultCourseOfferingSid.oneOf.0","typeLabel":"string"},{"type":"null","description":"Default course offering SID","uniqueKey":"defaultCourseOfferingSid.oneOf.1","typeLabel":"null"}],"uniqueKey":"defaultCourseOfferingSid","typeLabel":"string | null"},"name":{"oneOf":[{"type":"string","description":"Install name","uniqueKey":"name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Install name","uniqueKey":"name.oneOf.1","typeLabel":"null"}],"uniqueKey":"name","typeLabel":"string | null"},"defaultCurrencyCode":{"oneOf":[{"type":"string","description":"Default currency code","uniqueKey":"defaultCurrencyCode.oneOf.0","typeLabel":"string"},{"type":"null","description":"Default currency code","uniqueKey":"defaultCurrencyCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"defaultCurrencyCode","typeLabel":"string | null"},"defaultTimezone":{"oneOf":[{"type":"string","description":"Default timezone","uniqueKey":"defaultTimezone.oneOf.0","typeLabel":"string"},{"type":"null","description":"Default timezone","uniqueKey":"defaultTimezone.oneOf.1","typeLabel":"null"}],"uniqueKey":"defaultTimezone","typeLabel":"string | null"},"requireManagerProctorApproval":{"oneOf":[{"type":"boolean","description":"Require manager proctor approval","uniqueKey":"requireManagerProctorApproval.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Require manager proctor approval","uniqueKey":"requireManagerProctorApproval.oneOf.1","typeLabel":"null"}],"uniqueKey":"requireManagerProctorApproval","typeLabel":"boolean | null"},"requireManagerExamApproval":{"oneOf":[{"type":"boolean","description":"Require manager exam approval","uniqueKey":"requireManagerExamApproval.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Require manager exam approval","uniqueKey":"requireManagerExamApproval.oneOf.1","typeLabel":"null"}],"uniqueKey":"requireManagerExamApproval","typeLabel":"boolean | null"},"smarterIdEnabled":{"oneOf":[{"type":"boolean","description":"SmarterID enabled","uniqueKey":"smarterIdEnabled.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"SmarterID enabled","uniqueKey":"smarterIdEnabled.oneOf.1","typeLabel":"null"}],"uniqueKey":"smarterIdEnabled","typeLabel":"boolean | null"},"examNotes":{"oneOf":[{"type":"string","description":"Exam notes","uniqueKey":"examNotes.oneOf.0","typeLabel":"string"},{"type":"null","description":"Exam notes","uniqueKey":"examNotes.oneOf.1","typeLabel":"null"}],"uniqueKey":"examNotes","typeLabel":"string | null"},"enableWrittenExams":{"oneOf":[{"type":"boolean","description":"Enable written exams","uniqueKey":"enableWrittenExams.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Enable written exams","uniqueKey":"enableWrittenExams.oneOf.1","typeLabel":"null"}],"uniqueKey":"enableWrittenExams","typeLabel":"boolean | null"},"defaultNewExamType":{"oneOf":[{"type":"string","description":"Default new exam type","uniqueKey":"defaultNewExamType.oneOf.0","typeLabel":"string"},{"type":"null","description":"Default new exam type","uniqueKey":"defaultNewExamType.oneOf.1","typeLabel":"null"}],"uniqueKey":"defaultNewExamType","typeLabel":"string | null"},"hidePermittedItemFields":{"oneOf":[{"type":"array","description":"Hidden permitted item fields","items":{"type":"string","uniqueKey":"hidePermittedItemFields.oneOf.0.items.[INDEX]","typeLabel":"string"},"uniqueKey":"hidePermittedItemFields.oneOf.0","typeLabel":"string[]"},{"type":"null","description":"Hidden permitted item fields","items":{"type":"string"},"uniqueKey":"hidePermittedItemFields.oneOf.1","typeLabel":"null"}],"uniqueKey":"hidePermittedItemFields","typeLabel":"string[] | null"},"proctorTypes":{"type":"array","description":"Proctor types","items":{"type":"object","properties":{"sid":{"oneOf":[{"type":"string","description":"Proctor type SID","uniqueKey":"proctorTypes.items.[INDEX].sid.oneOf.0","typeLabel":"string"},{"type":"null","description":"Proctor type SID","uniqueKey":"proctorTypes.items.[INDEX].sid.oneOf.1","typeLabel":"null"}],"uniqueKey":"proctorTypes.items.[INDEX].sid","typeLabel":"string | null"},"status":{"oneOf":[{"type":"string","description":"Status","uniqueKey":"proctorTypes.items.[INDEX].status.oneOf.0","typeLabel":"string"},{"type":"null","description":"Status","uniqueKey":"proctorTypes.items.[INDEX].status.oneOf.1","typeLabel":"null"}],"uniqueKey":"proctorTypes.items.[INDEX].status","typeLabel":"string | null"},"automaticallyApprove":{"oneOf":[{"type":"boolean","description":"Automatically approve","uniqueKey":"proctorTypes.items.[INDEX].automaticallyApprove.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Automatically approve","uniqueKey":"proctorTypes.items.[INDEX].automaticallyApprove.oneOf.1","typeLabel":"null"}],"uniqueKey":"proctorTypes.items.[INDEX].automaticallyApprove","typeLabel":"boolean | null"},"proctorTypeSubCategorySid":{"oneOf":[{"type":"string","description":"Proctor type sub-category SID","uniqueKey":"proctorTypes.items.[INDEX].proctorTypeSubCategorySid.oneOf.0","typeLabel":"string"},{"type":"null","description":"Proctor type sub-category SID","uniqueKey":"proctorTypes.items.[INDEX].proctorTypeSubCategorySid.oneOf.1","typeLabel":"null"}],"uniqueKey":"proctorTypes.items.[INDEX].proctorTypeSubCategorySid","typeLabel":"string | null"},"sessionConfigurationSid":{"oneOf":[{"type":"string","description":"Session configuration SID","uniqueKey":"proctorTypes.items.[INDEX].sessionConfigurationSid.oneOf.0","typeLabel":"string"},{"type":"null","description":"Session configuration SID","uniqueKey":"proctorTypes.items.[INDEX].sessionConfigurationSid.oneOf.1","typeLabel":"null"}],"uniqueKey":"proctorTypes.items.[INDEX].sessionConfigurationSid","typeLabel":"string | null"},"reconnectionLockoutPeriod":{"oneOf":[{"type":"number","description":"Reconnection lockout period in seconds","uniqueKey":"proctorTypes.items.[INDEX].reconnectionLockoutPeriod.oneOf.0","typeLabel":"number"},{"type":"null","description":"Reconnection lockout period in seconds","uniqueKey":"proctorTypes.items.[INDEX].reconnectionLockoutPeriod.oneOf.1","typeLabel":"null"}],"uniqueKey":"proctorTypes.items.[INDEX].reconnectionLockoutPeriod","typeLabel":"number | null"},"reconnectionInSessionLockoutPeriod":{"oneOf":[{"type":"number","description":"Reconnection in-session lockout period in minutes","uniqueKey":"proctorTypes.items.[INDEX].reconnectionInSessionLockoutPeriod.oneOf.0","typeLabel":"number"},{"type":"null","description":"Reconnection in-session lockout period in minutes","uniqueKey":"proctorTypes.items.[INDEX].reconnectionInSessionLockoutPeriod.oneOf.1","typeLabel":"null"}],"uniqueKey":"proctorTypes.items.[INDEX].reconnectionInSessionLockoutPeriod","typeLabel":"number | null"},"maxReconnectionAttempts":{"oneOf":[{"type":"number","description":"Maximum reconnection attempts","uniqueKey":"proctorTypes.items.[INDEX].maxReconnectionAttempts.oneOf.0","typeLabel":"number"},{"type":"null","description":"Maximum reconnection attempts","uniqueKey":"proctorTypes.items.[INDEX].maxReconnectionAttempts.oneOf.1","typeLabel":"null"}],"uniqueKey":"proctorTypes.items.[INDEX].maxReconnectionAttempts","typeLabel":"number | null"},"modalityOptionPresetSid":{"oneOf":[{"type":"string","description":"Modality option preset SID","uniqueKey":"proctorTypes.items.[INDEX].modalityOptionPresetSid.oneOf.0","typeLabel":"string"},{"type":"null","description":"Modality option preset SID","uniqueKey":"proctorTypes.items.[INDEX].modalityOptionPresetSid.oneOf.1","typeLabel":"null"}],"uniqueKey":"proctorTypes.items.[INDEX].modalityOptionPresetSid","typeLabel":"string | null"}},"uniqueKey":"proctorTypes.items.[INDEX]","typeLabel":"object"},"uniqueKey":"proctorTypes","typeLabel":"object[]"},"enabled":{"oneOf":[{"type":"boolean","description":"Whether install is enabled","uniqueKey":"enabled.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Whether install is enabled","uniqueKey":"enabled.oneOf.1","typeLabel":"null"}],"uniqueKey":"enabled","typeLabel":"boolean | null"},"createdDate":{"oneOf":[{"type":"string","description":"Created date","uniqueKey":"createdDate.oneOf.0","typeLabel":"string"},{"type":"null","description":"Created date","uniqueKey":"createdDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"createdDate","typeLabel":"string | null"},"editDate":{"oneOf":[{"type":"string","description":"Last modified date","uniqueKey":"editDate.oneOf.0","typeLabel":"string"},{"type":"null","description":"Last modified date","uniqueKey":"editDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"editDate","typeLabel":"string | null"},"facialProcessing":{"oneOf":[{"type":"string","description":"Facial processing mode","uniqueKey":"facialProcessing.oneOf.0","typeLabel":"string"},{"type":"null","description":"Facial processing mode","uniqueKey":"facialProcessing.oneOf.1","typeLabel":"null"}],"uniqueKey":"facialProcessing","typeLabel":"string | null"},"pauseForProctorReview":{"oneOf":[{"type":"boolean","description":"Pause for proctor review","uniqueKey":"pauseForProctorReview.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Pause for proctor review","uniqueKey":"pauseForProctorReview.oneOf.1","typeLabel":"null"}],"uniqueKey":"pauseForProctorReview","typeLabel":"boolean | null"},"allowedExtensionIds":{"oneOf":[{"type":"array","description":"Allowed extension IDs","items":{"type":"string","uniqueKey":"allowedExtensionIds.oneOf.0.items.[INDEX]","typeLabel":"string"},"uniqueKey":"allowedExtensionIds.oneOf.0","typeLabel":"string[]"},{"type":"null","description":"Allowed extension IDs","items":{"type":"string"},"uniqueKey":"allowedExtensionIds.oneOf.1","typeLabel":"null"}],"uniqueKey":"allowedExtensionIds","typeLabel":"string[] | null"},"mandatoryRoomScanVideo":{"oneOf":[{"type":"boolean","description":"Mandatory room scan video","uniqueKey":"mandatoryRoomScanVideo.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Mandatory room scan video","uniqueKey":"mandatoryRoomScanVideo.oneOf.1","typeLabel":"null"}],"uniqueKey":"mandatoryRoomScanVideo","typeLabel":"boolean | null"},"secureSessionStatus":{"oneOf":[{"type":"string","description":"Secure session status","uniqueKey":"secureSessionStatus.oneOf.0","typeLabel":"string"},{"type":"null","description":"Secure session status","uniqueKey":"secureSessionStatus.oneOf.1","typeLabel":"null"}],"uniqueKey":"secureSessionStatus","typeLabel":"string | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"sid":"\u003cstring>","deploymentSid":"\u003cstring>","applicationSid":"\u003cstring>","defaultCourseOfferingSid":"\u003cstring>","name":"\u003cstring>","defaultCurrencyCode":"\u003cstring>","defaultTimezone":"\u003cstring>","requireManagerProctorApproval":true,"requireManagerExamApproval":true,"smarterIdEnabled":true,"examNotes":"\u003cstring>","enableWrittenExams":true,"defaultNewExamType":"\u003cstring>","hidePermittedItemFields":["\u003cstring>"],"proctorTypes":[{"sid":"\u003cstring>","status":"\u003cstring>","automaticallyApprove":true,"proctorTypeSubCategorySid":"\u003cstring>","sessionConfigurationSid":"\u003cstring>","reconnectionLockoutPeriod":123,"reconnectionInSessionLockoutPeriod":123,"maxReconnectionAttempts":123,"modalityOptionPresetSid":"\u003cstring>"}],"enabled":true,"createdDate":"\u003cstring>","editDate":"\u003cstring>","facialProcessing":"\u003cstring>","pauseForProctorReview":true,"allowedExtensionIds":["\u003cstring>"],"mandatoryRoomScanVideo":true,"secureSessionStatus":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"50c732bb-63a6-49e0-92e3-b6ebed732934":{"client":{"type":"apiKey","name":"token","in":"header","scopes":[]}}},"servers":{"c467fe82-756a-4d57-b25d-3f157236095f":{"url":"https://api.smarterproctoring.com"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","name":"token","in":"header","scopes":[]},"schema":{"title":"token","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"client","name":"token"}],"title":"client"}]},"originalFileLocation":"https://api.dev.smarterproctoring.com/openapi.json"},"subdomain":"smarterservicesllc","siteName":"SmarterServices Platform","title":"Get Settings - SmarterServices Platform","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-07-20T09:10:45.869Z","originalFileLocation":"api-reference/app-install/get-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=\"system\"}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 full settings object for the specified application install, including configuration options such as facial processing, proctor types, exam notes, and more.A valid authentication token must be provided in the token header.\">\u003cmeta data-mint-head name=\"application-name\" content=\"SmarterServices Platform\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/smarterservicesllc/B1jO8o0ggqMDkB2a/_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/smarterservicesllc/B1jO8o0ggqMDkB2a/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/smarterservicesllc/B1jO8o0ggqMDkB2a/_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/smarterservicesllc/B1jO8o0ggqMDkB2a/_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/smarterservicesllc/B1jO8o0ggqMDkB2a/_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/smarterservicesllc/B1jO8o0ggqMDkB2a/_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/smarterservicesllc/B1jO8o0ggqMDkB2a/_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/smarterservicesllc/B1jO8o0ggqMDkB2a/_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/smarterservicesllc/B1jO8o0ggqMDkB2a/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get Settings - SmarterServices Platform\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns the full settings object for the specified application install, including configuration options such as facial processing, proctor types, exam notes, and more.A valid authentication token must be provided in the token header.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"SmarterServices Platform\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developers.smarterservices.com/api-reference/app-install/get-settings\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://smarterservicesllc.mintlify.app/_mintlify/api/og/v2?division=App+Install\u0026amp;title=Get+Settings\u0026amp;description=Returns+the+full+settings+object+for+the+specified+application+install%2C+including+configuration+options+such+as+facial+processing%2C+proctor+types%2C+exam+notes%2C+an\u0026amp;theme=4042a3185e49c2c9f63be8ee\u0026amp;signature=6a283187f39b87d025deeabb63868079e365283f92450adb6a531a85dc8fe13d\">\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 Settings - SmarterServices Platform\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns the full settings object for the specified application install, including configuration options such as facial processing, proctor types, exam notes, and more.A valid authentication token must be provided in the token header.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://smarterservicesllc.mintlify.app/_mintlify/api/og/v2?division=App+Install\u0026amp;title=Get+Settings\u0026amp;description=Returns+the+full+settings+object+for+the+specified+application+install%2C+including+configuration+options+such+as+facial+processing%2C+proctor+types%2C+exam+notes%2C+an\u0026amp;theme=4042a3185e49c2c9f63be8ee\u0026amp;signature=6a283187f39b87d025deeabb63868079e365283f92450adb6a531a85dc8fe13d\">\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/smarterservicesllc/B1jO8o0ggqMDkB2a/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"SmarterServices Platform\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#015692\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developers.smarterservices.com/api-reference/app-install/get-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/app-install/get-settings.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developers.smarterservices.com/#organization\",\"name\":\"SmarterServices Platform\",\"url\":\"https://developers.smarterservices.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://cdn.prod.website-files.com/650b016f7e13a7d9de337f22/6629053ca1393100c09aa484_SmarterServices%20Logo.png\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developers.smarterservices.com#website\",\"name\":\"SmarterServices Platform\",\"url\":\"https://developers.smarterservices.com\",\"publisher\":{\"@id\":\"https://developers.smarterservices.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developers.smarterservices.com/api-reference/app-install/get-settings#webpage\",\"url\":\"https://developers.smarterservices.com/api-reference/app-install/get-settings\",\"name\":\"Get Settings\",\"description\":\"Returns the full settings object for the specified application install, including configuration options such as facial processing, proctor types, exam notes, and more.A valid authentication token must be provided in the token header.\",\"dateModified\":\"2026-07-20T09:10:45.869Z\",\"isPartOf\":{\"@id\":\"https://developers.smarterservices.com#website\"},\"breadcrumb\":{\"@id\":\"https://developers.smarterservices.com/api-reference/app-install/get-settings#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developers.smarterservices.com/api-reference/app-install/get-settings#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"SmarterServices Platform\",\"item\":\"https://developers.smarterservices.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get Settings\",\"item\":\"https://developers.smarterservices.com/api-reference/app-install/get-settings\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developers.smarterservices.com/api-reference/app-install/get-settings#apireference\",\"headline\":\"Get Settings\",\"name\":\"Get Settings\",\"description\":\"Returns the full settings object for the specified application install, including configuration options such as facial processing, proctor types, exam notes, and more.A valid authentication token must be provided in the token header.\",\"url\":\"https://developers.smarterservices.com/api-reference/app-install/get-settings\",\"mainEntityOfPage\":{\"@id\":\"https://developers.smarterservices.com/api-reference/app-install/get-settings#webpage\"},\"dateModified\":\"2026-07-20T09:10:45.869Z\",\"publisher\":{\"@id\":\"https://developers.smarterservices.com/#organization\"},\"isPartOf\":{\"@id\":\"https://developers.smarterservices.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"SmarterServices Platform\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"SmarterServices Platform","nav":{"global":null,"tabs":[{"tab":"Platform","icon":"layer-group","pages":[{"title":"Platform","href":""}]},{"tab":"Assessment","icon":"pen-to-square","pages":[{"title":"Assessment","href":"/assessment/api/introduction"}]},{"tab":"Proctoring","icon":"camera-security","groups":[{"group":"Getting Started","pages":[{"title":"Introduction","icon":"map","href":"/proctoring/introduction"},{"title":"Data Model","icon":"puzzle-piece","href":"/proctoring/datamodel"},{"title":"Authentication","icon":"key","href":"/proctoring/api/authentication"},{"title":"Resource Identifiers","icon":"cube","href":"/proctoring/api/resource-identifiers"}]},{"group":"Common Integrations","pages":[{"title":"Exam Platforms","icon":"plug","href":"/proctoring/common-integrations/exam-platform"},{"title":"Reporting Integrations","description":"Common patterns for pulling proctoring data from SmarterProctoring into your external reporting systems, dashboards, and workflows.","icon":"chart-mixed","href":"/proctoring/common-integrations/reporting"}]},{"group":"Endpoints","pages":[{"group":"App Install","pages":[{"title":"Get Settings","deprecated":null,"version":null,"openapi":"https://api.dev.smarterproctoring.com/openapi.json get /v1/installs/{installSid}/settings","href":"/api-reference/app-install/get-settings"}]},{"group":"Course","pages":[{"title":"Search for users enrolled in a course by name","description":null,"deprecated":null,"version":null,"openapi":"https://api.dev.smarterproctoring.com/openapi.json get /v1/installs/{installSid}/courses/{courseSid}/users","href":"/api-reference/course/search-for-users-enrolled-in-a-course-by-name"}]},{"group":"Course Offering","pages":[{"title":"List Course Offerings","deprecated":null,"version":null,"openapi":"https://api.dev.smarterproctoring.com/openapi.json get /v1/installs/{installSid}/courseOfferings","href":"/api-reference/course-offering/list-course-offerings"},{"title":"Create Course Offering","deprecated":null,"version":null,"openapi":"https://api.dev.smarterproctoring.com/openapi.json post /v1/installs/{installSid}/courseOfferings","href":"/api-reference/course-offering/create-course-offering"},{"title":"Course Offering Details","deprecated":null,"version":null,"openapi":"https://api.dev.smarterproctoring.com/openapi.json get /v1/installs/{installSid}/courseOfferings/{offeringSid}","href":"/api-reference/course-offering/course-offering-details"},{"title":"Update Course Offering","deprecated":null,"version":null,"openapi":"https://api.dev.smarterproctoring.com/openapi.json put /v1/installs/{installSid}/courseOfferings/{offeringSid}","href":"/api-reference/course-offering/update-course-offering"},{"title":"Delete Course Offering","deprecated":null,"version":null,"openapi":"https://api.dev.smarterproctoring.com/openapi.json delete /v1/installs/{installSid}/courseOfferings/{offeringSid}","href":"/api-reference/course-offering/delete-course-offering"}]},{"group":"Exam","pages":[{"title":"List Exams","deprecated":null,"version":null,"openapi":"https://api.dev.smarterproctoring.com/openapi.json get /v1/installs/{installSid}/courses/{courseSid}/exams","href":"/api-reference/exam/list-exams"},{"title":"Create Exam","deprecated":null,"version":null,"openapi":"https://api.dev.smarterproctoring.com/openapi.json post /v1/installs/{installSid}/courses/{courseSid}/exams","href":"/api-reference/exam/create-exam"},{"title":"Exam Details","deprecated":null,"version":null,"openapi":"https://api.dev.smarterproctoring.com/openapi.json get /v1/installs/{installSid}/courses/{courseSid}/exams/{examSid}","href":"/api-reference/exam/exam-details"},{"title":"Update Exam","deprecated":null,"version":null,"openapi":"https://api.dev.smarterproctoring.com/openapi.json put /v1/installs/{installSid}/courses/{courseSid}/exams/{examSid}","href":"/api-reference/exam/update-exam"},{"title":"Delete Exam","deprecated":null,"version":null,"openapi":"https://api.dev.smarterproctoring.com/openapi.json delete /v1/installs/{installSid}/courses/{courseSid}/exams/{examSid}","href":"/api-reference/exam/delete-exam"},{"title":"Get exam assignments","deprecated":null,"version":null,"openapi":"https://api.dev.smarterproctoring.com/openapi.json get /v1/installs/{installSid}/exams/{examSid}/assignments","href":"/api-reference/exam/get-exam-assignments"},{"title":"Update exam assignments","deprecated":null,"version":null,"openapi":"https://api.dev.smarterproctoring.com/openapi.json put /v1/installs/{installSid}/exams/{examSid}/assignments","href":"/api-reference/exam/update-exam-assignments"}]},{"group":"Exam Configuration","pages":[{"title":"List Configurations","deprecated":null,"version":null,"openapi":"https://api.dev.smarterproctoring.com/openapi.json get /v1/installs/{installSid}/courses/{courseSid}/exams/{examSid}/configurations","href":"/api-reference/exam-configuration/list-configurations"},{"title":"Create Configuration","deprecated":null,"version":null,"openapi":"https://api.dev.smarterproctoring.com/openapi.json post /v1/installs/{installSid}/courses/{courseSid}/exams/{examSid}/configurations","href":"/api-reference/exam-configuration/create-configuration"},{"title":"Get Configuration Details","deprecated":null,"version":null,"openapi":"https://api.dev.smarterproctoring.com/openapi.json get /v1/installs/{installSid}/courses/{courseSid}/exams/{examSid}/configurations/{examConfigurationSid}","href":"/api-reference/exam-configuration/get-configuration-details"},{"title":"Update Configuration","deprecated":null,"version":null,"openapi":"https://api.dev.smarterproctoring.com/openapi.json put /v1/installs/{installSid}/courses/{courseSid}/exams/{examSid}/configurations/{examConfigurationSid}","href":"/api-reference/exam-configuration/update-configuration"},{"title":"Delete Configuration","deprecated":null,"version":null,"openapi":"https://api.dev.smarterproctoring.com/openapi.json delete /v1/installs/{installSid}/courses/{courseSid}/exams/{examSid}/configurations/{examConfigurationSid}","href":"/api-reference/exam-configuration/delete-configuration"},{"title":"Upload Attachments","deprecated":null,"version":null,"openapi":"https://api.dev.smarterproctoring.com/openapi.json put /v1/installs/{installSid}/courses/{courseSid}/exams/{examSid}/configurations/{examConfigurationSid}/attachments","href":"/api-reference/exam-configuration/upload-attachments"},{"title":"Delete Attachments","deprecated":null,"version":null,"openapi":"https://api.dev.smarterproctoring.com/openapi.json delete /v1/installs/{installSid}/courses/{courseSid}/exams/{examSid}/configurations/{examConfigurationSid}/attachments","href":"/api-reference/exam-configuration/delete-attachments"}]},{"group":"Exam Events","pages":[{"title":"List Exam Events","deprecated":null,"version":null,"openapi":"https://api.dev.smarterproctoring.com/openapi.json get /v1/installs/{installSid}/exams/{examSid}/events","href":"/api-reference/exam-events/list-exam-events"},{"title":"Events By Student","deprecated":null,"version":null,"openapi":"https://api.dev.smarterproctoring.com/openapi.json get /v1/installs/{installSid}/exams/{examSid}/eventsByStudent","href":"/api-reference/exam-events/events-by-student"}]},{"group":"Exam Session","pages":[{"title":"List enrollment exam sessions","deprecated":null,"version":null,"openapi":"https://api.dev.smarterproctoring.com/openapi.json get /v1/installs/{installSid}/enrollments/{enrollmentSid}/exams/{examSid}/sessions","href":"/api-reference/exam-session/list-enrollment-exam-sessions"},{"title":"Exam Session Details","deprecated":null,"version":null,"openapi":"https://api.dev.smarterproctoring.com/openapi.json get /v1/installs/{installSid}/exams/{examSid}/sessions/{sessionSid}","href":"/api-reference/exam-session/exam-session-details"},{"title":"Reschedule Exam Session","deprecated":null,"version":null,"openapi":"https://api.dev.smarterproctoring.com/openapi.json put /v1/installs/{installSid}/exams/{examSid}/sessions/{sessionSid}","href":"/api-reference/exam-session/reschedule-exam-session"},{"title":"Schedule Exam Session","deprecated":null,"version":null,"openapi":"https://api.dev.smarterproctoring.com/openapi.json post /v1/installs/{installSid}/exams/{examSid}/sessions/{sessionSid}","href":"/api-reference/exam-session/schedule-exam-session"},{"title":"Cancel Exam Session","deprecated":null,"version":null,"openapi":"https://api.dev.smarterproctoring.com/openapi.json delete /v1/installs/{installSid}/exams/{examSid}/sessions/{sessionSid}","href":"/api-reference/exam-session/cancel-exam-session"},{"title":"Close Exam Session","deprecated":null,"version":null,"openapi":"https://api.dev.smarterproctoring.com/openapi.json post /v1/installs/{installSid}/exams/{examSid}/sessions/{sessionSid}/close","href":"/api-reference/exam-session/close-exam-session"}]},{"group":"Exam Session Annotation","pages":[{"title":"List Annotations","deprecated":null,"version":null,"openapi":"https://api.dev.smarterproctoring.com/openapi.json get /v2/installs/{installSid}/exams/{examSid}/sessions/{sessionSid}/annotations","href":"/api-reference/exam-session-annotation/list-annotations"},{"title":"Get Annotation Details","deprecated":null,"version":null,"openapi":"https://api.dev.smarterproctoring.com/openapi.json get /v2/installs/{installSid}/exams/{examSid}/sessions/{sessionSid}/annotations/{annotationSid}","href":"/api-reference/exam-session-annotation/get-annotation-details"}]},{"group":"Exam Session Event","pages":[{"title":"List Event Reports","deprecated":null,"version":null,"openapi":"https://api.dev.smarterproctoring.com/openapi.json get /v1/installs/{installSid}/exams/{examSid}/sessions/{sessionSid}/events","href":"/api-reference/exam-session-event/list-event-reports"},{"title":"Create Event Report","deprecated":null,"version":null,"openapi":"https://api.dev.smarterproctoring.com/openapi.json post /v1/installs/{installSid}/exams/{examSid}/sessions/{sessionSid}/events","href":"/api-reference/exam-session-event/create-event-report"},{"title":"Get Event Report","deprecated":null,"version":null,"openapi":"https://api.dev.smarterproctoring.com/openapi.json get /v1/installs/{installSid}/exams/{examSid}/sessions/{sessionSid}/events/{eventReportSid}","href":"/api-reference/exam-session-event/get-event-report"},{"title":"Update Event Report","deprecated":null,"version":null,"openapi":"https://api.dev.smarterproctoring.com/openapi.json put /v1/installs/{installSid}/exams/{examSid}/sessions/{sessionSid}/events/{eventReportSid}","href":"/api-reference/exam-session-event/update-event-report"},{"title":"Delete Event Report","deprecated":null,"version":null,"openapi":"https://api.dev.smarterproctoring.com/openapi.json delete /v1/installs/{installSid}/exams/{examSid}/sessions/{sessionSid}/events/{eventReportSid}","href":"/api-reference/exam-session-event/delete-event-report"},{"title":"Close Event Report","deprecated":null,"version":null,"openapi":"https://api.dev.smarterproctoring.com/openapi.json put /v1/installs/{installSid}/exams/{examSid}/sessions/{sessionSid}/events/{eventReportSid}/close","href":"/api-reference/exam-session-event/close-event-report"}]},{"group":"Onboarding","pages":[{"title":"Get the onboarding URL for an exam session","deprecated":null,"version":null,"openapi":"https://api.dev.smarterproctoring.com/openapi.json get /v1/installs/{installSid}/exams/{examSid}/sessions/{sessionSid}/onboard","href":"/api-reference/onboarding/get-the-onboarding-url-for-an-exam-session"}]},{"group":"Provision","pages":[{"title":"Bulk Provision Data","deprecated":null,"version":null,"openapi":"https://api.dev.smarterproctoring.com/openapi.json post /v2/installs/{installSid}/provision","href":"/api-reference/provision/bulk-provision-data"}]},{"group":"Reports","pages":[{"title":"Exams By Week","deprecated":null,"version":null,"openapi":"https://api.dev.smarterproctoring.com/openapi.json get /v1/installs/{installSid}/examsByWeek","href":"/api-reference/reports/exams-by-week"},{"title":"Exam Volume","deprecated":null,"version":null,"openapi":"https://api.dev.smarterproctoring.com/openapi.json get /v1/installs/{installSid}/examVolume","href":"/api-reference/reports/exam-volume"},{"title":"Exam Type Stats","deprecated":null,"version":null,"openapi":"https://api.dev.smarterproctoring.com/openapi.json get /v1/installs/{installSid}/reports/aggregatedStats","href":"/api-reference/reports/exam-type-stats"},{"title":"List Appointments","deprecated":null,"version":null,"openapi":"https://api.dev.smarterproctoring.com/openapi.json get /v1/installs/{installSid}/reports/appointments","href":"/api-reference/reports/list-appointments"},{"title":"Appointment Volume","deprecated":null,"version":null,"openapi":"https://api.dev.smarterproctoring.com/openapi.json get /v1/installs/{installSid}/reports/appointmentVolume","href":"/api-reference/reports/appointment-volume"},{"title":"Written Exam Audit","deprecated":null,"version":null,"openapi":"https://api.dev.smarterproctoring.com/openapi.json get /v1/installs/{installSid}/reports/audit","href":"/api-reference/reports/written-exam-audit"},{"title":"Churn Report","deprecated":null,"version":null,"openapi":"https://api.dev.smarterproctoring.com/openapi.json get /v1/installs/{installSid}/reports/churn","href":"/api-reference/reports/churn-report"},{"title":"Exam Overview","deprecated":null,"version":null,"openapi":"https://api.dev.smarterproctoring.com/openapi.json get /v1/installs/{installSid}/reports/examOverview","href":"/api-reference/reports/exam-overview"},{"title":"Session Events","deprecated":null,"version":null,"openapi":"https://api.dev.smarterproctoring.com/openapi.json get /v1/installs/{installSid}/reports/examSessionEvents","href":"/api-reference/reports/session-events"},{"title":"Modality Distribution","deprecated":null,"version":null,"openapi":"https://api.dev.smarterproctoring.com/openapi.json get /v1/installs/{installSid}/reports/modalityDistribution","href":"/api-reference/reports/modality-distribution"},{"title":"Proctor Volume","deprecated":null,"version":null,"openapi":"https://api.dev.smarterproctoring.com/openapi.json get /v1/installs/{installSid}/reports/proctorAccountVolume","href":"/api-reference/reports/proctor-volume"},{"title":"Service Distribution","deprecated":null,"version":null,"openapi":"https://api.dev.smarterproctoring.com/openapi.json get /v1/installs/{installSid}/reports/serviceDistribution","href":"/api-reference/reports/service-distribution"},{"title":"Session Requests","deprecated":null,"version":null,"openapi":"https://api.dev.smarterproctoring.com/openapi.json get /v1/installs/{installSid}/reports/sessionRequests","href":"/api-reference/reports/session-requests"},{"title":"Unscheduled Learners","deprecated":null,"version":null,"openapi":"https://api.dev.smarterproctoring.com/openapi.json get /v1/installs/{installSid}/reports/unscheduledLearners","href":"/api-reference/reports/unscheduled-learners"},{"title":"Calendar Capacity","deprecated":null,"version":null,"openapi":"https://api.dev.smarterproctoring.com/openapi.json get /v1/proctors/{proctorSid}/reports/calendarCapacity","href":"/api-reference/reports/calendar-capacity"},{"title":"Proctor Exam Details","deprecated":null,"version":null,"openapi":"https://api.dev.smarterproctoring.com/openapi.json get /v1/proctors/{proctorSid}/reports/examList","href":"/api-reference/reports/proctor-exam-details"},{"title":"Session Accommodations","deprecated":null,"version":null,"openapi":"https://api.dev.smarterproctoring.com/openapi.json get /v1/proctors/{proctorSid}/session-accommodations","href":"/api-reference/reports/session-accommodations"}]},{"group":"Time Zones","pages":[{"title":"List Time Zones","deprecated":null,"version":null,"openapi":"https://api.dev.smarterproctoring.com/openapi.json get /v1/timeZones","href":"/api-reference/time-zones/list-time-zones"}]},{"group":"User","pages":[{"title":"List Users","deprecated":null,"version":null,"openapi":"https://api.dev.smarterproctoring.com/openapi.json get /v1/installs/{installSid}/users","href":"/api-reference/user/list-users"},{"title":"Create User","deprecated":null,"version":null,"openapi":"https://api.dev.smarterproctoring.com/openapi.json post /v1/installs/{installSid}/users","href":"/api-reference/user/create-user"},{"title":"Update Admin User","deprecated":null,"version":null,"openapi":"https://api.dev.smarterproctoring.com/openapi.json put /v1/installs/{installSid}/users/{userSid}","href":"/api-reference/user/update-admin-user"},{"title":"Delete User","deprecated":null,"version":null,"openapi":"https://api.dev.smarterproctoring.com/openapi.json delete /v1/installs/{installSid}/users/{userSid}","href":"/api-reference/user/delete-user"},{"title":"Get User Profile","deprecated":null,"version":null,"openapi":"https://api.dev.smarterproctoring.com/openapi.json get /v1/installs/{installSid}/users/{userSid}/profile","href":"/api-reference/user/get-user-profile"},{"title":"Update User Profile","deprecated":null,"version":null,"openapi":"https://api.dev.smarterproctoring.com/openapi.json put /v1/installs/{installSid}/users/{userSid}/profile","href":"/api-reference/user/update-user-profile"}]}]}]},{"tab":"SmarterElements","icon":"puzzle-piece","pages":[{"title":"SmarterElements","href":"/smarter-elements/overview"}]},{"tab":"Blog","icon":"book","href":"https://www.smarterservices.com/blog"}]},"basePath":"","title":"Get Settings - SmarterServices Platform","buildId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","deploymentId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CS552b7R.js","utils-DDTCYAF2.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-De8ttokP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DrwRDvAh.js","snippetPresets-DtAN0nWx.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D5rWArI6.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-O2i12wsz.js","shallow-DV8xABTt.js","getApiPlaygroundDisplay-DBZ0B5Jx.js","CodeSnippet-BVi0tPUX.js","CodeSnippets-CqASbIwY.js","Page-m07pfKpT.js","getPastedJson-DG9vsMS8.js","icon-CXzRSCr8.js","MethodPill-BdKVtEuX.js","DuplicateIcon-CZlmBrJI.js","createIcon-biFEUKPL.js","DynamicMarkdown-B54_zNBF.js","SectionHeading-DwwHK3Pt.js","axios-vUo_bRtp.js","Markdown-DfhCTwyA.js","clsx-xpJZXxdP.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BTZUMDnx.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-DqdKa2R4.js"]}