Synap Documentation
⌘
Ctrl
k
GitBook Assistant
Ask
Platform Overview
Customer Support
More
Synap Academy
Platform Docs
API Docs
Legals
For the complete documentation index, see
llms.txt
. This page is also available as
Markdown
.
GitBook Assistant
Ask
On this page
API Docs
API Reference
Models
AccessMigration
Show properties
AccessPolicy
Show properties
AccessPolicyReset
Show properties
AccountClosure
Show properties
AccountClosureRequest
Show properties
ActionLog
Show properties
Annotation
Show properties
ApiError
Show properties
Assignment
Show properties
AssignmentFolder
Show properties
AssignmentGroup
Show properties
AssignmentGroupCourseVersion
Show properties
AssignmentGroupDataExport
Show properties
AssignmentGroupHeadlineInsight
Show properties
AssignmentHeadlineInsight
Show properties
AssignmentItemAudio
Show properties
AssignmentItemDocument
Show properties
AssignmentItemEmbed
Show properties
AssignmentItemNote
Show properties
AssignmentItemPulse
Show properties
AssignmentItemQuiz
Show properties
AssignmentItemReview
Show properties
AssignmentItemScorm
Show properties
AssignmentItemSelfAssessmentOutcome
Show properties
AssignmentItemSurvey
Show properties
AssignmentItemTextEntry
Show properties
AssignmentItemUpload
Show properties
AssignmentItemVideo
Show properties
AssignmentItemZip
Show properties
AssignmentManualReview
Show properties
AssignmentReattempt
Show properties
AssignmentReset
Show properties
AssignmentRevocation
Show properties
AssignmentScormResult
Show properties
AssignmentSelfAssessmentReport
Show properties
Attempt
Show properties
AttemptActiveDuration
Show properties
AttemptChart
Show properties
AttemptCodeLogin
Show properties
AttemptInsight
Show properties
AttemptLock
Show properties
AttemptMarking
Show properties
AttemptMarksSubmission
Show properties
AttemptOverride
Show properties
AttemptPlayerState
Show properties
AttemptResultConfig
Show properties
AttemptRevokeReversal
Show properties
AttemptSchedule
Show properties
AttemptSitting
Show properties
AttemptSubmission
Show properties
AttemptTagLabel
Show properties
AttemptTimer
Show properties
AttemptTimerReset
Show properties
AttributeConfig
Show properties
AuthenticationOption
Show properties
AuthenticationOptionAdfs
Show properties
AuthenticationOptionAuth0
Show properties
AuthenticationOptionJwt
Show properties
AuthenticationOptionLocal
Show properties
AuthenticationOptionLti1p1
Show properties
AuthenticationOptionLti1p3
Show properties
AuthenticationOptionSaml
Show properties
AvailableAccessPolicy
Show properties
BackgroundJob
Show properties
BadRequestApiError
Show properties
BillingInfo
Show properties
BotSession
Show properties
BotUser
Show properties
Certificate
Show properties
ChartJs
Show properties
CheckoutSession
Show properties
CloneJob
Show properties
Collection
Show properties
CollectionAccess
Show properties
CollectionFolder
Show properties
CollectionItem
Show properties
CollectionItemAudio
Show properties
CollectionItemDocument
Show properties
CollectionItemEmbed
Show properties
CollectionItemNote
Show properties
CollectionItemPdfExport
Show properties
CollectionItemQuiz
Show properties
CollectionItemVideo
Show properties
CollectionItemZip
Show properties
CollectionMock
Show properties
CollectionPdfExport
Show properties
CollectionProgress
Show properties
CollectionSubFolder
Show properties
CollectionTagBreakdown
Show properties
Content
Show properties
ContentEmbedDatum
Show properties
Course
Show properties
CourseFolder
Show properties
CourseItem
Show properties
CourseItemAudio
Show properties
CourseItemDocument
Show properties
CourseItemEmbed
Show properties
CourseItemNote
Show properties
CourseItemQuiz
Show properties
CourseItemScorm
Show properties
CourseItemSurvey
Show properties
CourseItemTextEntry
Show properties
CourseItemUpload
Show properties
CourseItemVideo
Show properties
CourseItemZip
Show properties
CustomInsight
Show properties
Document
Show properties
EmailVerification
Show properties
EmqGroupExport
Show properties
EmqGroupImport
Show properties
EmqGroupImportValidation
Show properties
EnrichedAttempt
Show properties
EnrichedAttemptOption
Show properties
Exam-V-2
Show properties
ExamAttemptHeadlineInsight
Show properties
ExamCandidateExport
Show properties
ExamHall
Show properties
ExamineeNotification
Show properties
ExamPreview
Show properties
ExamQuestionStats
Show properties
ExamQuestionStatsExport
Show properties
ExamSchedule
Show properties
ExamStats
Show properties
ExamTemplate
Show properties
ExamTemplateSection
Show properties
ExamVoucher
Show properties
ExamVoucherBatchJob
Show properties
ExamVoucherExport
Show properties
ExportEnrichedAttempt
Show properties
ExternalExamSitting
Show properties
ExternalProctorSession
Show properties
ExternalProctorSessionResults
Show properties
FacetConfig
Show properties
File
Show properties
Flag
Show properties
FlagExport
Show properties
ForbiddenApiError
Show properties
GeneratedAccount
Show properties
GeneratedTest
Show properties
GenerateTestJob
Show properties
GenericNotification
Show properties
GenericResource
Show properties
GlobalExamTemplate
Show properties
Highlight
Show properties
IceCandidate
Show properties
InsightsTagBreakdown
Show properties
Integration
Show properties
Invite
Show properties
InviteExport
Show properties
Invoice
Show properties
LearningRecord
Show properties
LearningRecordExport
Show properties
LegacyAccessUpgradeOption
Show properties
LoginQrCode
Show properties
ManageBillingSession
Show properties
MarketingConsent
Show properties
MarkingEntry
Show properties
MarkingSession
Show properties
MarkingState
Show properties
MAUPortalUsage
Show properties
MfaActivation
Show properties
MfaConfig
Show properties
MfaDeactivation
Show properties
MobileAttempt
Show properties
MobileAudioContent
Show properties
MobileCollection
Show properties
MobileCollectionFolder
Show properties
MobileCollectionItem
Show properties
MobileNote
Show properties
MobileQuiz
Show properties
MobileResponse
Show properties
MobileSession
Show properties
MobileSpacedLearning
Show properties
MobileStudyItem
Show properties
MobileUser
Show properties
Note
Show properties
NotFoundApiError
Show properties
NotificationGroup
Show properties
ObjectId
Show properties
PasswordReset
Show properties
PasswordResetRequest
Show properties
PAYGPortalUsage
Show properties
PdfAnnotation
Show properties
PersonalAccessToken
Show properties
PlayerAttempt
Show properties
PlayerAudioResponse
Show properties
PlayerClozeDragAndDropResponse
Show properties
PlayerClozeDropDownResponse
Show properties
PlayerClozeTextResponse
Show properties
PlayerDrawingResponse
Show properties
PlayerEmqGroup
Show properties
PlayerFileUploadResponse
Show properties
PlayerFlashcardResponse
Show properties
PlayerFreeTextResponse
Show properties
PlayerImageHotspotResponse
Show properties
PlayerInformationalResponse
Show properties
PlayerMultipleChoiceResponse
Show properties
PlayerOffPlatformResponse
Show properties
PlayerRankedResponse
Show properties
PlayerSection
Show properties
PlayerShortAnswerResponse
Show properties
PlayerSingleChoiceResponse
Show properties
PlayerSpreadsheetResponse
Show properties
PlayerTrueOrFalseResponse
Show properties
PlayerVideoResponse
Show properties
Portal
Show properties
PortalStore
Show properties
PortalUsage
Show properties
ProctorCapture
Show properties
ProctorEventLog
Show properties
ProctorReview
Show properties
ProctorSession
Show properties
Product
Show properties
ProductList
Show properties
PublicAttributeConfig
Show properties
PublicAuthenticationOption
Show properties
PublicCertificate
Show properties
QuestionExport
Show properties
QuestionImport
Show properties
QuestionImportValidation
Show properties
QuestionSummary
Show properties
Quiz
Show properties
QuizAttemptSetupConfig
Show properties
QuizEmqGroup
Show properties
QuizPdfAttemptExport
Show properties
QuizPdfExport
Show properties
QuizQuestionAudioRecording
Show properties
QuizQuestionClozeDragAndDrop
Show properties
QuizQuestionClozeDropDown
Show properties
QuizQuestionClozeText
Show properties
QuizQuestionDrawing
Show properties
QuizQuestionFileUpload
Show properties
QuizQuestionFlashcard
Show properties
QuizQuestionFreeText
Show properties
QuizQuestionImageHotspot
Show properties
QuizQuestionInformational
Show properties
QuizQuestionMultipleCorrect
Show properties
QuizQuestionOffPlatform
Show properties
QuizQuestionRanked
Show properties
QuizQuestionShortAnswer
Show properties
QuizQuestionSingleCorrect
Show properties
QuizQuestionSpreadsheet
Show properties
QuizQuestionTrueOrFalse
Show properties
QuizQuestionVideoRecording
Show properties
QuizSection
Show properties
QuizSetupValidation
Show properties
QuizTagBreakdown
Show properties
RelationLink
Show properties
Relationship
Show properties
ResourceIdentifierArray
Show properties
ResourceIdentifierObject
Show properties
ResourceType
Show properties
Response
Show properties
ScormCourse
Show properties
SearchFilterConfig
Show properties
SearchResult
Show properties
SessionContext
Show properties
StoreOffer
Show properties
Study
Show properties
StudyItem
Show properties
SubPortal
Show properties
Subscription
Show properties
Survey
Show properties
SurveyItem
Show properties
SurveyPage
Show properties
SurveyResponse
Show properties
SynopticAiReview
Show properties
SynopticCapture
Show properties
SynopticDomRecording
Show properties
SynopticEventLog
Show properties
SynopticSession
Show properties
SynopticWatchToken
Show properties
Tag
Show properties
TagSet
Show properties
Template
Show properties
Test
Show properties
TipSuggestion
Show properties
Token
Show properties
TransactionalEmail
Show properties
UnauthorizedApiError
Show properties
UrlLink
Show properties
UrlString
Show properties
User
Show properties
UserAccount
Show properties
UserAttribute
Show properties
UserEngagement
Show properties
UserGroup
Show properties
UserGroupExport
Show properties
UserGroupLink
Show properties
UserGroupLinkAccess
Show properties
UserGroupLinkSettings
Show properties
UserGroupLinkValidation
Show properties
UserImport
Show properties
UserPassword
Show properties
UserRegistration
Show properties
UserSession
Show properties
UserStats
Show properties
UserType
Show properties
WebhookDelivery
Show properties
WebhookSamplePayload
Show properties
WebhookSubscription
Show properties
ZapierApiKey
Show properties
Previous
Update User
Last updated
5 hours ago
Was this helpful?
AccessMigration
AccessPolicy
AccessPolicyReset
AccountClosure
AccountClosureRequest
ActionLog
Annotation
ApiError
Assignment
AssignmentFolder
AssignmentGroup
AssignmentGroupCourseVersion
AssignmentGroupDataExport
AssignmentGroupHeadlineInsight
AssignmentHeadlineInsight
AssignmentItemAudio
AssignmentItemDocument
AssignmentItemEmbed
AssignmentItemNote
AssignmentItemPulse
AssignmentItemQuiz
AssignmentItemReview
AssignmentItemScorm
AssignmentItemSelfAssessmentOutcome
AssignmentItemSurvey
AssignmentItemTextEntry
AssignmentItemUpload
AssignmentItemVideo
AssignmentItemZip
AssignmentManualReview
AssignmentReattempt
AssignmentReset
AssignmentRevocation
AssignmentScormResult
AssignmentSelfAssessmentReport
Attempt
AttemptActiveDuration
AttemptChart
AttemptCodeLogin
AttemptInsight
AttemptLock
AttemptMarking
AttemptMarksSubmission
AttemptOverride
AttemptPlayerState
AttemptResultConfig
AttemptRevokeReversal
AttemptSchedule
AttemptSitting
AttemptSubmission
AttemptTagLabel
AttemptTimer
AttemptTimerReset
AttributeConfig
AuthenticationOption
AuthenticationOptionAdfs
AuthenticationOptionAuth0
AuthenticationOptionJwt
AuthenticationOptionLocal
AuthenticationOptionLti1p1
AuthenticationOptionLti1p3
AuthenticationOptionSaml
AvailableAccessPolicy
BackgroundJob
BadRequestApiError
BillingInfo
BotSession
BotUser
Certificate
ChartJs
CheckoutSession
CloneJob
Collection
CollectionAccess
CollectionFolder
CollectionItem
CollectionItemAudio
CollectionItemDocument
CollectionItemEmbed
CollectionItemNote
CollectionItemPdfExport
CollectionItemQuiz
CollectionItemVideo
CollectionItemZip
CollectionMock
CollectionPdfExport
CollectionProgress
CollectionSubFolder
CollectionTagBreakdown
Content
ContentEmbedDatum
Course
CourseFolder
CourseItem
CourseItemAudio
CourseItemDocument
CourseItemEmbed
CourseItemNote
CourseItemQuiz
CourseItemScorm
CourseItemSurvey
CourseItemTextEntry
CourseItemUpload
CourseItemVideo
CourseItemZip
CustomInsight
Document
EmailVerification
EmqGroupExport
EmqGroupImport
EmqGroupImportValidation
EnrichedAttempt
EnrichedAttemptOption
Exam-V-2
ExamAttemptHeadlineInsight
ExamCandidateExport
ExamHall
ExamineeNotification
ExamPreview
ExamQuestionStats
ExamQuestionStatsExport
ExamSchedule
ExamStats
ExamTemplate
ExamTemplateSection
ExamVoucher
ExamVoucherBatchJob
ExamVoucherExport
ExportEnrichedAttempt
ExternalExamSitting
ExternalProctorSession
ExternalProctorSessionResults
FacetConfig
File
Flag
FlagExport
ForbiddenApiError
GeneratedAccount
GeneratedTest
GenerateTestJob
GenericNotification
GenericResource
GlobalExamTemplate
Highlight
IceCandidate
InsightsTagBreakdown
Integration
Invite
InviteExport
Invoice
LearningRecord
LearningRecordExport
LegacyAccessUpgradeOption
LoginQrCode
ManageBillingSession
MarketingConsent
MarkingEntry
MarkingSession
MarkingState
MAUPortalUsage
MfaActivation
MfaConfig
MfaDeactivation
MobileAttempt
MobileAudioContent
MobileCollection
MobileCollectionFolder
MobileCollectionItem
MobileNote
MobileQuiz
MobileResponse
MobileSession
MobileSpacedLearning
MobileStudyItem
MobileUser
Note
NotFoundApiError
NotificationGroup
ObjectId
PasswordReset
PasswordResetRequest
PAYGPortalUsage
PdfAnnotation
PersonalAccessToken
PlayerAttempt
PlayerAudioResponse
PlayerClozeDragAndDropResponse
PlayerClozeDropDownResponse
PlayerClozeTextResponse
PlayerDrawingResponse
PlayerEmqGroup
PlayerFileUploadResponse
PlayerFlashcardResponse
PlayerFreeTextResponse
PlayerImageHotspotResponse
PlayerInformationalResponse
PlayerMultipleChoiceResponse
PlayerOffPlatformResponse
PlayerRankedResponse
PlayerSection
PlayerShortAnswerResponse
PlayerSingleChoiceResponse
PlayerSpreadsheetResponse
PlayerTrueOrFalseResponse
PlayerVideoResponse
Portal
PortalStore
PortalUsage
ProctorCapture
ProctorEventLog
ProctorReview
ProctorSession
Product
ProductList
PublicAttributeConfig
PublicAuthenticationOption
PublicCertificate
QuestionExport
QuestionImport
QuestionImportValidation
QuestionSummary
Quiz
QuizAttemptSetupConfig
QuizEmqGroup
QuizPdfAttemptExport
QuizPdfExport
QuizQuestionAudioRecording
QuizQuestionClozeDragAndDrop
QuizQuestionClozeDropDown
QuizQuestionClozeText
QuizQuestionDrawing
QuizQuestionFileUpload
QuizQuestionFlashcard
QuizQuestionFreeText
QuizQuestionImageHotspot
QuizQuestionInformational
QuizQuestionMultipleCorrect
QuizQuestionOffPlatform
QuizQuestionRanked
QuizQuestionShortAnswer
QuizQuestionSingleCorrect
QuizQuestionSpreadsheet
QuizQuestionTrueOrFalse
QuizQuestionVideoRecording
QuizSection
QuizSetupValidation
QuizTagBreakdown
RelationLink
Relationship
ResourceIdentifierArray
ResourceIdentifierObject
ResourceType
Response
ScormCourse
SearchFilterConfig
SearchResult
SessionContext
StoreOffer
Study
StudyItem
SubPortal
Subscription
Survey
SurveyItem
SurveyPage
SurveyResponse
SynopticAiReview
SynopticCapture
SynopticDomRecording
SynopticEventLog
SynopticSession
SynopticWatchToken
Tag
TagSet
Template
Test
TipSuggestion
Token
TransactionalEmail
UnauthorizedApiError
UrlLink
UrlString
User
UserAccount
UserAttribute
UserEngagement
UserGroup
UserGroupExport
UserGroupLink
UserGroupLinkAccess
UserGroupLinkSettings
UserGroupLinkValidation
UserImport
UserPassword
UserRegistration
UserSession
UserStats
UserType
WebhookDelivery
WebhookSamplePayload
WebhookSubscription
ZapierApiKey
Was this helpful?
