# SmarterServices Platform

## Docs

- [Get Settings](https://developers.smarterservices.com/api-reference/app-install/get-settings.md): 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.
- [Course Offering Details](https://developers.smarterservices.com/api-reference/course-offering/course-offering-details.md): Returns the full course offering object for the specified offering SID.<br/><br/>Includes title, match strings, start/end dates, and associated metadata.
- [Create Course Offering](https://developers.smarterservices.com/api-reference/course-offering/create-course-offering.md): Creates a new course offering (e.g., semester, term, or academic period) under the specified application install.<br/><br/>The `matchStrings` field is used to automatically match incoming courses from the LMS to this offering based on text patterns.
- [Delete Course Offering](https://developers.smarterservices.com/api-reference/course-offering/delete-course-offering.md): Permanently deletes the specified course offering.<br/><br/>Courses currently assigned to this offering may need to be reassigned.
- [List Course Offerings](https://developers.smarterservices.com/api-reference/course-offering/list-course-offerings.md): Returns a paginated list of course offerings (terms/semesters) for the specified application install.<br/><br/>Supports standard pagination via `offset` and `limit`.
- [Update Course Offering](https://developers.smarterservices.com/api-reference/course-offering/update-course-offering.md): Replaces the full course offering configuration with the provided payload.<br/><br/>All required fields (`title`, `matchStrings`) must be provided.
- [Create Configuration](https://developers.smarterservices.com/api-reference/exam-configuration/create-configuration.md): Creates a new exam configuration (e.g., student-specific overrides for scheduling windows, permitted items, and proctoring settings).<br/><br/>The payload must include either `enrollmentSid` or `referenceExamConfigurationSid` (XOR constraint).
- [Delete Attachments](https://developers.smarterservices.com/api-reference/exam-configuration/delete-attachments.md): Removes specified attachment files or exam files from the exam configuration.<br/><br/>The payload specifies file names to delete from attachments or examFiles arrays.
- [Delete Configuration](https://developers.smarterservices.com/api-reference/exam-configuration/delete-configuration.md): Permanently deletes the specified exam configuration.<br/><br/>Returns a success message upon successful deletion.
- [Get Configuration Details](https://developers.smarterservices.com/api-reference/exam-configuration/get-configuration-details.md): Returns the full exam configuration including scheduling windows, permitted items, proctoring settings, and instructor-as-proctor entries.
- [List Configurations](https://developers.smarterservices.com/api-reference/exam-configuration/list-configurations.md): Returns a paginated list of exam configurations for the specified exam.<br/><br/>Can be filtered by `enrollmentSid` to find configurations for a specific student.<br/><br/>Supports sorting and pagination via query parameters.
- [Update Configuration](https://developers.smarterservices.com/api-reference/exam-configuration/update-configuration.md): Replaces the full exam configuration with the provided payload including scheduling, permitted items, proctoring settings, and instructor-as-proctor entries.<br/><br/>The user role from the auth token is passed to the handler for role-based logic.
- [Upload Attachments](https://developers.smarterservices.com/api-reference/exam-configuration/upload-attachments.md): Uploads exam file attachments (e.g., exam papers, instruction sheets) via multipart/form-data.<br/><br/>Accepts up to 5 attachment files or 1 exam file per request.
- [Events By Student](https://developers.smarterservices.com/api-reference/exam-events/events-by-student.md): Returns event reports for the specified exam, grouped by student/enrollment.
- [List Exam Events](https://developers.smarterservices.com/api-reference/exam-events/list-exam-events.md): Returns a paginated list of event reports across all sessions for the specified exam.<br/><br/>Supports filtering and sorting via query parameters.
- [Get Annotation Details](https://developers.smarterservices.com/api-reference/exam-session-annotation/get-annotation-details.md): Returns the full annotation object for the specified annotation SID.
- [List Annotations](https://developers.smarterservices.com/api-reference/exam-session-annotation/list-annotations.md): Returns a paginated list of annotations for the specified exam session.<br/><br/>Supports filtering and sorting via query parameters.
- [Close Event Report](https://developers.smarterservices.com/api-reference/exam-session-event/close-event-report.md): Marks the specified event report as closed/resolved.<br/><br/>The `eventReportSid` is validated through the hierarchy: eventReport → session → exam → appInstall.
- [Create Event Report](https://developers.smarterservices.com/api-reference/exam-session-event/create-event-report.md): Records a session event (e.g., browser focus lost, microphone detected, suspicious activity) on the specified exam session.
- [Delete Event Report](https://developers.smarterservices.com/api-reference/exam-session-event/delete-event-report.md): Deletes the specified event report.<br/><br/>The `eventReportSid` is validated through the hierarchy: eventReport → session → exam → appInstall.
- [Get Event Report](https://developers.smarterservices.com/api-reference/exam-session-event/get-event-report.md): Returns the full event report object for the specified event report SID.<br/><br/>The `eventReportSid` is validated through the hierarchy: eventReport → session → exam → appInstall.
- [List Event Reports](https://developers.smarterservices.com/api-reference/exam-session-event/list-event-reports.md): Returns a paginated list of session event reports for the specified exam session.<br/><br/>Supports filtering and sorting via query parameters.
- [Update Event Report](https://developers.smarterservices.com/api-reference/exam-session-event/update-event-report.md): Updates the specified event report with the provided payload fields.<br/><br/>The `eventReportSid` is validated through the hierarchy: eventReport → session → exam → appInstall.
- [Cancel Exam Session](https://developers.smarterservices.com/api-reference/exam-session/cancel-exam-session.md): Cancels the specified exam session. The auth token is passed for auditing.<br/><br/>An optional payload may include cancellation reason details.
- [Close Exam Session](https://developers.smarterservices.com/api-reference/exam-session/close-exam-session.md): Closes the exam session, finalizing the session state and triggering post-session workflows.
- [Exam Session Details](https://developers.smarterservices.com/api-reference/exam-session/exam-session-details.md): Returns the full exam session object including scheduling, proctoring, and status details.
- [List enrollment exam sessions](https://developers.smarterservices.com/api-reference/exam-session/list-enrollment-exam-sessions.md): Returns a paginated list of exam sessions for the given enrollment and exam combination.
- [Reschedule Exam Session](https://developers.smarterservices.com/api-reference/exam-session/reschedule-exam-session.md): Changes the scheduled date/time for an existing exam session.<br/><br/>The auth token is passed for proctor reassignment and auditing.
- [Schedule Exam Session](https://developers.smarterservices.com/api-reference/exam-session/schedule-exam-session.md): Creates a scheduled exam session under the specified exam.
- [Create Exam](https://developers.smarterservices.com/api-reference/exam/create-exam.md): Creates a new exam configuration under the specified course.<br/><br/>The payload includes exam metadata (title, type, URL), proctoring configuration, permitted items, scheduling windows, and instructor-as-proctor settings.
- [Delete Exam](https://developers.smarterservices.com/api-reference/exam/delete-exam.md): Performs a soft delete on the specified exam, marking it as deleted without permanently removing data.<br/><br/>The exam will no longer appear in active listings but its data is retained.
- [Exam Details](https://developers.smarterservices.com/api-reference/exam/exam-details.md): Returns the full exam object including configuration, permitted items, proctoring settings, and scheduling windows.<br/><br/>Also evaluates the LaunchDarkly virtual test center version feature flag for the requesting user.
- [Get exam assignments](https://developers.smarterservices.com/api-reference/exam/get-exam-assignments.md)
- [List Exams](https://developers.smarterservices.com/api-reference/exam/list-exams.md): Returns a paginated list of exams belonging to the specified course.<br/><br/>Supports filtering with `includeStatusSummary` to include enrollment status counts per exam.<br/><br/>Supports sorting by `title`, `examOpenDate`, or `scheduleOpenDate`.
- [Update Exam](https://developers.smarterservices.com/api-reference/exam/update-exam.md): Replaces the full exam configuration with the provided payload.<br/><br/>Includes exam metadata, scheduling windows, permitted items, proctoring settings, and instructor-as-proctor configurations.<br/><br/>The user role from the auth token is passed to the handler for role-based logic.
- [Update exam assignments](https://developers.smarterservices.com/api-reference/exam/update-exam-assignments.md)
- [Get the onboarding URL for an exam session](https://developers.smarterservices.com/api-reference/onboarding/get-the-onboarding-url-for-an-exam-session.md): Returns the onboarding URL where the student completes pre-exam steps (e.g., system check, ID verification).
- [Bulk Provision Data](https://developers.smarterservices.com/api-reference/provision/bulk-provision-data.md): Provisions multiple types of data (e.g., courses, exams, enrollments) in a single bulk operation for the specified install.
- [Appointment Volume](https://developers.smarterservices.com/api-reference/reports/appointment-volume.md): Returns an appointment volume (peak exam) report for the specified install.
- [Churn Report](https://developers.smarterservices.com/api-reference/reports/churn-report.md): Returns a churn report for the specified install.
- [Exam Overview](https://developers.smarterservices.com/api-reference/reports/exam-overview.md): Returns an exam overview report for the specified install.
- [Exam Type Stats](https://developers.smarterservices.com/api-reference/reports/exam-type-stats.md): Returns aggregated statistics for exam types for the next 10 days.
- [Exam Volume](https://developers.smarterservices.com/api-reference/reports/exam-volume.md): Returns an exam volume report for the specified install.
- [Exams By Week](https://developers.smarterservices.com/api-reference/reports/exams-by-week.md): Returns exams grouped by week based on the given filter parameters.
- [List Appointments](https://developers.smarterservices.com/api-reference/reports/list-appointments.md): Returns all appointments based on the given filter parameters.
- [Modality Distribution](https://developers.smarterservices.com/api-reference/reports/modality-distribution.md): Returns a report on modality distribution for the specified install.
- [Proctor Exam Details](https://developers.smarterservices.com/api-reference/reports/proctor-exam-details.md): Returns detailed exam information for the specified proctor account.
- [Proctor Volume](https://developers.smarterservices.com/api-reference/reports/proctor-volume.md): Returns a volume report for proctor accounts associated with the specified install.
- [Service Distribution](https://developers.smarterservices.com/api-reference/reports/service-distribution.md): Returns a service distribution report for the specified install.
- [Session Accommodations](https://developers.smarterservices.com/api-reference/reports/session-accommodations.md): Returns session accommodation data for the specified proctor account.
- [Session Events](https://developers.smarterservices.com/api-reference/reports/session-events.md): Returns exam session event reports for the specified install.
- [Session Requests](https://developers.smarterservices.com/api-reference/reports/session-requests.md): Returns all message threads that have active session requests for the specified install.
- [Unscheduled Learners](https://developers.smarterservices.com/api-reference/reports/unscheduled-learners.md): Returns a paginated list of students who have not yet scheduled their exam sessions.
- [Written Exam Audit](https://developers.smarterservices.com/api-reference/reports/written-exam-audit.md): Returns an audit report for written exams within the specified install.
- [List Time Zones](https://developers.smarterservices.com/api-reference/time-zones/list-time-zones.md): Returns a paginated list of supported time zones.<br/><br/>Supports sorting by `createdDate` and pagination via `offset` and `limit`.
- [Create User](https://developers.smarterservices.com/api-reference/user/create-user.md): Creates a new user for the specified install.
- [Delete User](https://developers.smarterservices.com/api-reference/user/delete-user.md): Deletes the specified user from the install.
- [Get User Profile](https://developers.smarterservices.com/api-reference/user/get-user-profile.md): Returns the user profile for the specified user within the install.
- [List Users](https://developers.smarterservices.com/api-reference/user/list-users.md): Returns a paginated list of users for the specified install.
- [Update Admin User](https://developers.smarterservices.com/api-reference/user/update-admin-user.md): Updates admin-specific fields for the specified user within the install.
- [Update User Profile](https://developers.smarterservices.com/api-reference/user/update-user-profile.md): Updates the user profile for the specified user within the install.
- [Authentication](https://developers.smarterservices.com/assessment/api/authentication.md)
- [Error Messages & Codes](https://developers.smarterservices.com/assessment/api/errors.md)
- [Introduction](https://developers.smarterservices.com/assessment/api/introduction.md): Documentation for the assessment (SmarterMeasure) API
- [Search Results](https://developers.smarterservices.com/assessment/api/results/search.md): Search for results
- [Search Results (expanded)](https://developers.smarterservices.com/assessment/api/results/search-expanded.md): Search for results with expanded data including new sections.
- [User Report](https://developers.smarterservices.com/assessment/api/results/user-report.md): Return report for a specific user
- [User Results](https://developers.smarterservices.com/assessment/api/results/user-results.md): Return results for a specific user
- [Create User](https://developers.smarterservices.com/assessment/api/users/create-user.md): Create a new user/assessment
- [Get User](https://developers.smarterservices.com/assessment/api/users/get-user.md): Get a specific user
- [List Users](https://developers.smarterservices.com/assessment/api/users/list-users.md): Get a list of users that match the specified criteria
- [Report Link](https://developers.smarterservices.com/assessment/api/users/report-link.md): Provides a URL that can be used to view the report for the user.
- [Sign On](https://developers.smarterservices.com/assessment/api/users/signon.md): Provides a URL that can be used to sign the user into the system.
- [Update User](https://developers.smarterservices.com/assessment/api/users/update-user.md): Update a specific user
- [SmarterServices Platform](https://developers.smarterservices.com/index.md): Integration documentation for the SmarterServices Platform
- [Alert](https://developers.smarterservices.com/platform/blockkit/alert.md): A block that displays an alert message with different severity levels
- [Block Replacement](https://developers.smarterservices.com/platform/blockkit/blockreplacement.md): A block that serves as a placeholder for dynamic content
- [Bullet List](https://developers.smarterservices.com/platform/blockkit/bulletlist.md): A block that displays an unordered (bullet) list
- [Callout](https://developers.smarterservices.com/platform/blockkit/callout.md): A block that displays a callout with an icon, title, and content to highlight important information
- [Heading](https://developers.smarterservices.com/platform/blockkit/heading.md): A block that displays a heading with a specified level
- [Icon](https://developers.smarterservices.com/platform/blockkit/icon.md): A block that displays an icon with optional color and alignment
- [List Item](https://developers.smarterservices.com/platform/blockkit/listitem.md): A list item that can be used in bullet or ordered lists
- [Ordered List](https://developers.smarterservices.com/platform/blockkit/orderedlist.md): A block that displays a numbered (ordered) list
- [Overview](https://developers.smarterservices.com/platform/blockkit/overview.md): BlockKit is a powerful system that allows you to build dynamic user interfaces using JSON structures. It provides a set of predefined elements that can be composed together to create rich, interactive experiences.
- [Section](https://developers.smarterservices.com/platform/blockkit/section.md): A container block that groups other block elements together
- [Step](https://developers.smarterservices.com/platform/blockkit/step.md): A block that represents a step in a process or workflow
- [Step List](https://developers.smarterservices.com/platform/blockkit/steplist.md): A block that displays a list of steps in a process or workflow
- [Text](https://developers.smarterservices.com/platform/blockkit/text.md): A block that displays formatted text with optional replacements
- [Wizard](https://developers.smarterservices.com/platform/blockkit/wizard.md): A block that displays a multi-step wizard with navigation controls
- [Wizard Step](https://developers.smarterservices.com/platform/blockkit/wizardstep.md): A block that represents a single step in a wizard
- [Actions](https://developers.smarterservices.com/platform/security/actions.md): IAM action naming conventions and wildcard patterns
- [Client Libraries](https://developers.smarterservices.com/platform/security/clients.md): Available IAM client libraries for different platforms and languages
- [Conditions](https://developers.smarterservices.com/platform/security/conditions.md): Advanced conditional access controls for IAM policies
- [Implementation Guide](https://developers.smarterservices.com/platform/security/implementation.md): How to integrate IAM into your applications and services
- [Introduction](https://developers.smarterservices.com/platform/security/index.md): Complete guide to SmarterServices Identity and Access Management (IAM) system
- [Policy Structure](https://developers.smarterservices.com/platform/security/policies.md): IAM policy syntax, structure, and examples
- [Quick Start](https://developers.smarterservices.com/platform/security/quickstart.md): Get up and running with SmarterServices IAM in minutes
- [Resource Naming (SSRN)](https://developers.smarterservices.com/platform/security/resources.md): SmarterServices Resource Name format for identifying protected resources
- [Authentication](https://developers.smarterservices.com/proctoring/api/authentication.md): Authentication for SmarterProctoring API
- [Resource Identifiers](https://developers.smarterservices.com/proctoring/api/resource-identifiers.md): Resource identifiers for SmarterProctoring API
- [Exam Platforms](https://developers.smarterservices.com/proctoring/common-integrations/exam-platform.md): Integrate an external exam platform with SmarterProctoring to provision exams, manage users, schedule sessions, and launch onboarding.
- [Reporting Integrations](https://developers.smarterservices.com/proctoring/common-integrations/reporting.md): Common patterns for pulling proctoring data from SmarterProctoring into your external reporting systems, dashboards, and workflows.
- [Data Model](https://developers.smarterservices.com/proctoring/datamodel.md): Diagram showing the high level data model for the Proctoring application.
- [Introduction](https://developers.smarterservices.com/proctoring/introduction.md): Proctoring (SmarterProctoring) integration capabilities
- [API Reference](https://developers.smarterservices.com/smarter-elements/api-reference.md): Complete API documentation for SmarterElements
- [Overview](https://developers.smarterservices.com/smarter-elements/elements.md): Complete reference of all available SmarterElements
- [Builder](https://developers.smarterservices.com/smarter-elements/elements/blockkit-playground.md): Interactive editor for creating, testing, and previewing BlockKit JSON structures with real-time rendering and validation
- [Renderer](https://developers.smarterservices.com/smarter-elements/elements/blockkit-renderer.md): Renders BlockKit JSON structures into interactive UI components with support for dynamic content, replacements, and event handling
- [Session Viewer](https://developers.smarterservices.com/smarter-elements/elements/proctoring-sessionviewer.md): A component for viewing and interacting with proctoring sessions
- [Examples](https://developers.smarterservices.com/smarter-elements/examples.md): Practical examples and use cases for SmarterElements
- [Getting Started](https://developers.smarterservices.com/smarter-elements/getting-started.md): Learn how to integrate SmarterElements into your application
- [SmarterElements](https://developers.smarterservices.com/smarter-elements/overview.md): Embeddable UI components with iframe isolation and modal support
- [Troubleshooting](https://developers.smarterservices.com/smarter-elements/troubleshooting.md): Common issues and solutions for SmarterElements

## OpenAPI Specs

- [openapi](https://developers.smarterservices.com/openapi.json)

## Optional

- [Blog](https://www.smarterservices.com/blog)