Synap API
    Synap API
    • Getting Started
    • Authentication
    • Error Handling
    • Rate Limits
    • Versioning
    • Security
    • Proctor Integration
      • Introduction
      • Launch
      • Complete
      • Cancel
      • Review Status
    • API Reference
      • AccessPolicy
        • Create AccessMigration
        • Create AccessPolicy
        • List AccessPolicies
        • Get AccessPolicy
        • Update AccessPolicy
        • Delete AccessPolicy
        • Create AccessPolicyReset
        • List AvailableAccessPolicies
      • User
        • Create AccountClosureRequest
        • Create AccountClosure
        • Confirm account closure by patching with a confirmation token, received via email from the create action.
        • Create EmailVerificationRequest
        • Create EmailVerification
        • Update EmailVerification
        • Create ExternalExamSitting
        • List ExternalExamSittings
        • Update ExternalExamSitting
        • Create InviteExport
        • List Invites
        • Get Invite
        • Update Invite
        • Create LearningRecord export
        • Create LearningRecord
        • List LearningRecords
        • Get LearningRecord
        • Update LearningRecord
        • Delete LearningRecord
        • Get App Login QR Code
        • Create MarketingConsent
        • Delete MarketingConsent
        • Create PasswordResetRequest
        • Create PasswordReset
        • Update PasswordReset
        • Get Session Context
        • Get UserAccount
        • List UserEngagement
        • Create UserPassword
        • Register User
        • Get UserStats
        • List Users
        • Get User
        • Update User
        • Delete User
      • Assignment
        • Create AssignmentGroupCourseVersion
        • List AssignmentGroupCourseVersions
        • Create AssignmentGroupDataExport
        • Get AssignmentGroupHeadlineInsight
        • Create AssignmentGroup
        • Get AssignmentGroup
        • Update AssignmentGroup
        • Delete AssignmentGroup
        • Get AssignmentHeadlineInsight
        • Create AssignmentManualReview
        • Create AssignmentRevocation
        • Delete AssignmentRevocation
        • List Assignments
      • Attempt
        • Create AttemptLock
        • Delete AttemptLock
        • Get AttemptMarkSession
        • List AttemptMarkSessions
        • Create AttemptMarkerEntry
        • Create AttemptMarksSubmission
        • Create AttemptOverride
        • List AttemptOverrides
        • Get AttemptPlayerState
        • Create AttemptRevocation
        • Delete AttemptRevocation
        • List AttemptSchedules
        • Get AttemptSchedule
        • Update AttemptSchedule
        • Create AttemptSitting
        • Create AttemptSubmission
        • List Attempt Tag Labels
        • Create AttemptTimerReset
        • List AttemptTimers
        • Get AttemptTimer
        • Update AttemptTimer
        • Create Attempt
        • List Attempts
        • Get Attempt
        • Assign Markers
        • Unassign Markers
        • Assign Moderating Markers
        • Unassign Moderating Markers
        • Assign Backreaders
        • Unassign Backreaders
        • Assign Escalating Markers
        • Unassign Escalating Markers
        • Assign Auditing Markers
        • Unassign Auditing Markers
        • Assign Provisional Markers
        • Unassign Provisional Markers
        • Update Attempt Responses
        • List EnrichedAttemptOptions
        • List EnrichedAttempts
        • Create ExamPreview
        • Create ExportEnrichedAttempt
        • Get MarkableResponse
        • Update MarkableResponse
        • List MarkableResponses
        • Get PlayerAttempt
        • Update PlayerAttempt
        • Delete PlayerAttempt
        • Get Response
        • Update Response
        • Get Response
        • Update Response
        • Get Response
        • Update Response
        • Get Response
        • Update Response
        • Get Response
        • Update Response
        • Get Response
        • Update Response
        • Get Response
        • Update Response
        • Get Response
        • Update Response
        • Get Response
        • Update Response
        • Get PlayerSection
        • Update PlayerSection
        • Get Response
        • Update Response
        • Get Response
        • Update Response
        • Get QuestionMarkSession
      • Exams
        • Create AttemptRevokeReversal
        • List AttemptRevokeReversals
        • Get AttemptRevokeReversal
        • Update AttemptRevokeReversal
        • Delete AttemptRevokeReversal
        • Get ExamAttemptHeadlineInsight
        • Create ExamClosure
        • Get ExamHall
        • List ExamClosures
        • List ExamQuestionStats
        • Get ExamClosure
        • Create ExamQuestionStatsExport
        • Update ExamClosure
        • Create ExamV2
        • Delete ExamClosure
        • Find ExamV2s
        • Get ExamV2
        • Update ExamV2
        • Delete ExamV2
        • Get ExamSchedule
        • Create Internal Markers Group
        • Update ExamSchedule
        • Set Shared Markers Group
        • Create ExamSection
        • Create Internal Moderating Markers Group
        • Get ExamSection
        • Set Shared Moderating Markers Group
        • Update ExamSection
        • Set Shared Escalating Markers Group
        • Delete ExamSection
        • Set Shared Auditing Markers Group
        • Create ExamTargetQuizSetupValidation
        • Create Internal Escalating Markers Group
        • Get ExamTestTagBreakdown
        • Create Internal Auditing Markers Group
        • Create Internal BackReading Markers Group
        • Set Shared BackReading Markers Group
        • Update Exam Section
        • Creates a new draft version of the underlying quiz
        • Discards the current draft quiz and replaces it with the latest published version.
        • Sets a quiz as the current published version. New attempts for this exam will use the publishedVersion quiz.
        • Create ExamineeNotification
        • List MarkersInboxItems
        • Creates a new draft version of the underlying quiz
        • Creates a new draft version of the underlying quiz
        • Get Exam
        • Update Exam
        • Delete Exam
        • Create Exam
        • Create Internal Markers Group
        • Set Shared Markers Group
        • Create Internal Moderating Markers Group
        • Set Shared Moderating Markers Group
        • Update Exam Section
      • AttributeConfig
        • Create AttributeConfig
        • List AttributeConfigs
        • Get AttributeConfig
        • Update AttributeConfig
        • Delete AttributeConfig
        • List PublicAttributeConfigs
      • Authentication
        • Create ADFS AuthenticationOption
        • Get ADFS AuthenticationOption
        • Update ADFS AuthenticationOption
        • Delete ADFS AuthenticationOption
        • Create Auth0 AuthenticationOption
        • Get Auth0 AuthenticationOption
        • Update Auth0 AuthenticationOption
        • Delete Auth0 AuthenticationOption
        • Create JWT AuthenticationOption
        • Get JWT AuthenticationOption
        • Update JWT AuthenticationOption
        • Delete JWT AuthenticationOption
        • Get Local AuthenticationOption
        • Update Local AuthenticationOption
        • Create LTI1.3 AuthenticationOption
        • Get LTI1.3 AuthenticationOption
        • Update LTI1.3 AuthenticationOption
        • Delete LTI1.3 AuthenticationOption
        • Create SAML AuthenticationOption
        • Get SAML AuthenticationOption
        • Update SAML AuthenticationOption
        • Delete SAML AuthenticationOption
        • List AuthenticationOptions
        • Create BotSession
        • Create PersonalAccessToken
        • List PersonalAccessTokens
        • Update PersonalAccessToken
        • Delete PersonalAccessToken
        • List PublicAuthenticationOptions
        • Get Token
        • Create ZapierApiKey
        • List ZapierApiKeys
        • Update ZapierApiKey
        • Delete ZapierApiKey
      • JobQueue
        • Get BackgroundJob
      • BotUser
        • Create BotUser
        • List BotUsers
      • Certificate
        • Get Certificate
        • Find Certificate by attempt
        • Create Certificate
        • Find Public Certificates by attempt and hash
        • List Templates
      • ChartJS
        • Get Chart
      • Content Management
        • Create a new clone job.
        • Create a new clone job.
        • List FacetConfigs
        • Create TagSet
        • List TagSets
        • Get TagSet
        • Update TagSet
        • Delete TagSet
        • Create Tag
        • List Tags
        • Get Tag
        • Update Tag
        • Delete Tag
      • Collections
        • Get CollectionItemNote
        • Create Annotation
        • List Annotations
        • Get Annotation
        • Update Annotation
        • Delete Annotation
        • Add collection access to a user group
        • Delete collection access
        • Create CollectionFolder
        • List CollectionFolders
        • Get CollectionFolder
        • Update CollectionFolder
        • Delete CollectionFolder
        • Reorder CollectionFolder Items
        • Create CollectionSubFolder
        • Get CollectionSubFolder
        • Update CollectionSubFolder
        • Delete CollectionSubFolder
        • Reorder CollectionSubFolder Items
        • Create CollectionItemAudio
        • List CollectionItems - use generic CollectionItem
        • Get CollectionItemAudio
        • Update CollectionItemAudio
        • Delete CollectionItemAudio
        • Get CollectionItemDocument
        • Update CollectionItemDocument
        • Delete CollectionItemDocument
        • Create CollectionItemDocument
        • Create CollectionItemEmbed
        • List CollectionItems - use generic CollectionItem
        • Get CollectionItemEmbed
        • Update CollectionItemEmbed
        • Delete CollectionItemEmbed
        • Create CollectionItemNote
        • List CollectionItems - use generic CollectionItem
        • Get CollectionItemNote
        • Update CollectionItemNote
        • Delete CollectionItemNote
        • Create CollectionItemQuiz
        • List CollectionItems - use generic CollectionItem
        • Get CollectionItemQuiz
        • Update CollectionItemQuiz
        • Delete CollectionItemQuiz
        • Create CollectionItemVideo
        • List CollectionItems - use generic CollectionItem
        • Get CollectionItemVideo
        • Update CollectionItemVideo
        • Delete CollectionItemVideo
        • Create CollectionItemZip
        • List CollectionItems - use generic CollectionItem
        • Get CollectionItemZip
        • Update CollectionItemZip
        • Delete CollectionItemZip
        • List CollectionItems
        • List CollectionMocks
        • Create a CollectionProgress
        • List CollectionProgresses
        • Update a CollectionProgress
        • Get CollectionTagBreakdown
        • List Collections
        • Create Collection
        • Get Collection
        • Update Collection
        • Delete Collection
        • Reorder Collection Folders
        • Reorder Collection Items
        • Create Highlight
        • List Highlights
        • Get Highlight
        • Update Highlight
        • Delete Highlight
      • Library
        • Create ContentEmbedDatum
        • Create Content
        • Get Content
        • Update Content
        • Delete Content
        • Get Note
        • Delete Note
      • Course
        • Create CourseFolder
        • List CourseFolders
        • Get CourseFolder
        • Update CourseFolder
        • Delete CourseFolder
        • Update CourseFolder Items
        • Create CourseItemAudio
        • List CourseItems - use generic CourseItem
        • Get CourseItemAudio
        • Update CourseItemAudio
        • Delete CourseItemAudio
        • Create CourseItemDocument
        • List CourseItems - use generic CourseItem
        • Get CourseItemDocument
        • Update CourseItemDocument
        • Delete CourseItemDocument
        • Create CourseItemEmbed
        • List CourseItems - use generic CourseItem
        • Get CourseItemEmbed
        • Update CourseItemEmbed
        • Delete CourseItemEmbed
        • Create CourseItemNote
        • List CourseItems - use generic CourseItem
        • Get CourseItemNote
        • Update CourseItemNote
        • Delete CourseItemNote
        • Create CourseItemQuiz
        • List CourseItems - use generic CourseItem
        • Get CourseItemQuiz
        • Update CourseItemQuiz
        • Delete CourseItemQuiz
        • Create CourseItemScorm
        • List CourseItems - use generic CourseItem
        • Get CourseItemScorm
        • Update CourseItemScorm
        • Delete CourseItemScorm
        • Create CourseItemSurvey
        • List CourseItems - use generic CourseItem
        • Get CourseItemSurvey
        • Update CourseItemSurvey
        • Delete CourseItemSurvey
        • Create CourseItemTextEntry
        • List CourseItems - use generic CourseItem
        • Get CourseItemTextEntry
        • Update CourseItemTextEntry
        • Delete CourseItemTextEntry
        • Create CourseItemUpload
        • List CourseItems - use generic CourseItem
        • Get CourseItemUpload
        • Update CourseItemUpload
        • Delete CourseItemUpload
        • Create CourseItemVideo
        • List CourseItems - use generic CourseItem
        • Get CourseItemVideo
        • Update CourseItemVideo
        • Delete CourseItemVideo
        • Create CourseItemZip
        • List CourseItems - use generic CourseItem
        • Get CourseItemZip
        • Update CourseItemZip
        • Delete CourseItemZip
        • List CourseItems
        • Create Course
        • Get Course
        • Update Course
        • Delete Course
        • Reorder Course Folders
        • Reorder Course Items
      • Quiz
        • Create EmqExport
        • Create EmqGroupImportValidation
        • Create EmqGroupImport
        • Create GenerateTestJob.
        • Get GenerateTestJob.
        • Generate Quiz
        • Create QuestionExport
        • Create QuestionImportValidation
        • Create QuestionImport background job
        • Create QuizEmqGroup
        • Get QuizEmqGroup
        • Update QuizEmqGroup
        • Delete QuizEmqGroup
        • Update quiz section questions.
        • Get QuizPdfExport
        • Create QuizQuestionAudioRecording
        • List QuizQuestionAudioRecording
        • Get QuizQuestionAudioRecording
        • Update QuizQuestionAudioRecording
        • Delete QuizQuestionAudioRecording
        • Create QuizQuestionClozeDragAndDrop
        • List QuizQuestionClozeDragAndDrop
        • Get QuizQuestionClozeDragAndDrop
        • Update QuizQuestionClozeDragAndDrop
        • Delete QuizQuestionClozeDragAndDrop
        • Create QuizQuestionClozeDropDown
        • List QuizQuestionClozeDropDown
        • Get QuizQuestionClozeDropDown
        • Update QuizQuestionClozeDropDown
        • Delete QuizQuestionClozeDropDown
        • Create QuizQuestionClozeText
        • List QuizQuestionClozeText
        • Get QuizQuestionClozeText
        • Update QuizQuestionClozeText
        • Delete QuizQuestionClozeText
        • Create QuizQuestionFileUpload
        • List QuizQuestionFileUpload
        • Get QuizQuestionFileUpload
        • Update QuizQuestionFileUpload
        • Delete QuizQuestionFileUpload
        • Create QuizQuestionFreeText
        • List QuizQuestionFreeText
        • Get QuizQuestionFreeText
        • Update QuizQuestionFreeText
        • Delete QuizQuestionFreeText
        • Create QuizQuestionInformational
        • List QuizQuestionInformational
        • Get QuizQuestionInformational
        • Update QuizQuestionInformational
        • Delete QuizQuestionInformational
        • Create QuizQuestionMultipleCorrect
        • List QuizQuestionMultipleCorrect
        • Get QuizQuestionMultipleCorrect
        • Update QuizQuestionMultipleCorrect
        • Delete QuizQuestionMultipleCorrect
        • Create QuizQuestionRanked
        • List QuizQuestionRanked
        • Get QuizQuestionRanked
        • Update QuizQuestionRanked
        • Delete QuizQuestionRanked
        • Creates a new QuizQuestionShortAnswer.
        • Find a set of QuizQuestionShortAnswer.
        • Fetch a specific QuizQuestionShortAnswer.
        • Update fields on a specific QuizQuestionShortAnswer.
        • Delete a specific QuizQuestionShortAnswer.
        • Create QuizQuestionSingleCorrect
        • List QuizQuestionSingleCorrect
        • Get QuizQuestionSingleCorrect
        • Update QuizQuestionSingleCorrect
        • Delete QuizQuestionSingleCorrect
        • Create QuizSection
        • List QuizSections
        • Get QuizSection
        • Update QuizSection
        • Delete QuizSection
        • Update quiz section questions.
        • Add quiz section questions.
        • Update source quizz relations on a specific Quiz.
        • Create QuizSetupValidation
        • Get QuizTagBreakdown
        • Create Quiz
        • Get Quiz
        • Update Quiz
        • Delete Quiz
        • Update Quiz Questions
        • Update Quiz Sections.
        • Update source content quiz relations on a specific Quiz.
        • Update source settings quiz relation on a specific Quiz. Only applicable for static quizzes.
        • Get Test
        • Delete Test
        • List Tests
      • Proctor
        • Get ExternalProctorSessionResult
        • Create ExternalProctorSession
        • List ProctorCaptures
        • List ProctorEventLogs
        • List ProctorReviews
        • Create ProctorReview
        • Get ProctorSession
      • File
        • Create File
        • Get File
      • Flag
        • Create FlagExport
        • Create Flag
        • List Flags
        • Get Flag
        • Update Flag
      • GenerateAccount
        • Generate UserAccount
      • Notifications
        • Create GenericNotification
        • List NotificationGroups
        • Get TransactionalEmail
        • List TransactionalEmails
      • Integrations
        • Create Integration
        • Get Integration
        • Update Integration
        • Delete Integration
      • Mfa
        • Activate MFA
        • Get MFAConfig
        • Create MFAConfig
        • Deactivate MFA
      • Billing
        • Get Portal Usage
        • List Subscriptions
        • Get Subscription
      • Portal
        • Get Portal
        • Update Portal
        • Create SubPortal
        • List SubPortals
        • Get SubPortal
        • Update SubPortal
        • Delete SubPortal
        • Create WebhookSubscription
        • List WebhookSubscriptions
        • Get WebhookSubscription
        • Update WebhookSubscription
        • Delete WebhookSubscription
      • Scorm
        • Create ScormCourse
        • Create ScormCourse
        • Update ScormCourse
        • Delete ScormCourse
      • Search
        • List SearchFilterConfigs
        • Search
      • Survey
        • Delete Survey
      • TipSuggestion
        • Create TipSuggestion
        • List TipSuggestions
      • UserGroup
        • Create UserGroupExport
        • Create UserGroupLinkAccess
        • List UserGroupLinkSettings
        • Create UserGroupLinkSetting
        • Get UserGroupLinkSetting
        • Update UserGroupLinkSetting
        • Validate UserGroupLink
        • Get UserGroupLink
        • Create UserGroup
        • List UserGroups
        • Get UserGroup
        • Update UserGroup
        • Delete UserGroup
        • Add Users to UserGroup
        • Remove Users from UserGroup
        • Create UserImport
        • List UserTypes
        • Get UserGroup
        • Update UserGroup
      • Audit
        • Create ActionLog
        • List ActionLogs
        • Get ActionLog
      • MarkingEntry
      • MarkingSession
      • Insights
        • Find custom insights
        • List InsightsTagBreakdown
      • Marking
        • Create MarkingEntry
        • List MarkingEntries
        • Update MarkingEntry
        • Get MarkingSession
        • Update MarkingSession
        • Get MarkingSession
        • Create MarkingState
        • List MarkingStates
        • Get MarkingState
        • Update MarkingState
        • Delete MarkingState
      • Shop
        • Create CheckoutSession
        • Get CheckoutSession
        • Update CheckoutSession
        • Create PortalStore
        • List PortalStores
        • Get PortalStore
        • Update PortalStore
        • Delete PortalStore
        • Create ProductList
        • List ProductLists
        • Get ProductList
        • Update ProductList
        • Delete ProductList
        • Add Products
        • Remove Products
        • Create Product
        • List Products
        • Get Product
        • Update Product
        • Delete Product
        • Get StoreOffer
      • Revision
        • Find question summaries
        • Get study
        • Update a Study
        • Find a study for a user
        • Create Study
        • Add Items to Study
        • Remove Items from Study
        • Get Study Item
        • Delete Study Item
        • Create Study Item
      • Mobile
        • Create MobileAttempt
        • Find MobileAttempts
        • Get MobileAttempt
        • Update MobileAttempt
        • Create MobileCollectionItem
        • List MobileCollectionItems
        • Get MobileCollectionItem
        • Update MobileCollectionItem
        • Delete MobileCollectionItem
        • List MobileCollections
        • Get MobileCollection
        • List MobileResponses
        • Get MobileResponse
        • Update MobileResponse
        • Get MobileSession
        • Get MobileSpacedLearning
        • Update MobileSpacedLearning
        • Update Study items
        • Update Study items
        • Create MobileUser
        • Get MobileUser
      • Get result config for attempt
        GET

    Rate Limits

    TODO
    Previous
    Error Handling
    Next
    Versioning
    Built with