---
title: "Get Settings"
method: GET
path: "/v1/installs/{installSid}/settings"
tags: ["App Install"]
---

# Get Settings

`GET /v1/installs/{installSid}/settings`

Returns the full settings object for the specified application install, including configuration options such as facial processing, proctor types, exam notes, and more.<br/><br/>A valid authentication token must be provided in the `token` header.

## Path parameters

- `installSid` string, required — Unique SID of the application install. Must match the pattern `AI` followed by 32 hex characters.

## Response `200`

Successful

- AppInstallSettingsResponse
  - `sid` string, nullable — Install SID
  - `deploymentSid` string, nullable — Deployment SID
  - `applicationSid` string, nullable — Application SID
  - `defaultCourseOfferingSid` string, nullable — Default course offering SID
  - `name` string, nullable — Install name
  - `defaultCurrencyCode` string, nullable — Default currency code
  - `defaultTimezone` string, nullable — Default timezone
  - `requireManagerProctorApproval` boolean, nullable — Require manager proctor approval
  - `requireManagerExamApproval` boolean, nullable — Require manager exam approval
  - `smarterIdEnabled` boolean, nullable — SmarterID enabled
  - `examNotes` string, nullable — Exam notes
  - `enableWrittenExams` boolean, nullable — Enable written exams
  - `defaultNewExamType` string, nullable — Default new exam type
  - `hidePermittedItemFields` string[], nullable — Hidden permitted item fields
  - `proctorTypes` AppInstallProctorTypeResponse[] — Proctor types
    - `sid` string, nullable — Proctor type SID
    - `status` string, nullable — Status
    - `automaticallyApprove` boolean, nullable — Automatically approve
    - `proctorTypeSubCategorySid` string, nullable — Proctor type sub-category SID
    - `sessionConfigurationSid` string, nullable — Session configuration SID
    - `reconnectionLockoutPeriod` number, nullable — Reconnection lockout period in seconds
    - `reconnectionInSessionLockoutPeriod` number, nullable — Reconnection in-session lockout period in minutes
    - `maxReconnectionAttempts` number, nullable — Maximum reconnection attempts
    - `modalityOptionPresetSid` string, nullable — Modality option preset SID
  - `enabled` boolean, nullable — Whether install is enabled
  - `createdDate` string, nullable — Created date
  - `editDate` string, nullable — Last modified date
  - `facialProcessing` string, nullable — Facial processing mode
  - `pauseForProctorReview` boolean, nullable — Pause for proctor review
  - `allowedExtensionIds` string[], nullable — Allowed extension IDs
  - `mandatoryRoomScanVideo` boolean, nullable — Mandatory room scan video
  - `secureSessionStatus` string, nullable — Secure session status

---

[API](https://skmtc.net/smarterproctoring/apis/smarterproctoring-api-2.md) · [All operations](https://skmtc.net/smarterproctoring/apis/smarterproctoring-api-2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/smarterproctoring/smarterproctoring-api-2/versions/561e0d9fd244/schema)