Synap API
  1. Course
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
      • Get 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
      • Get AssignmentFolder
      • Create AssignmentGroupCourseVersion
      • List AssignmentGroupCourseVersions
      • Create AssignmentGroupDataExport
      • Get AssignmentGroupHeadlineInsight
      • Create AssignmentGroup
      • Get AssignmentGroup
      • Update AssignmentGroup
      • Delete AssignmentGroup
      • Get AssignmentHeadlineInsight
      • Get AssignmentItemAudio
      • Update AssignmentItemAudio
      • Get AssignmentItemDocument
      • Update AssignmentItemDocument
      • Get AssignmentItemEmbed
      • Update AssignmentItemEmbed
      • Get AssignmentItemNote
      • Update AssignmentItemNote
      • Get AssignmentItemQuiz
      • Update AssignmentItemQuiz
      • Get AssignmentItemScorm
      • Update AssignmentItemScorm
      • Get AssignmentItemSurvey
      • Update AssignmentItemSurvey
      • Get AssignmentItemTextEntry
      • Update AssignmentItemTextEntry
      • Get AssignmentItemUpload
      • Update AssignmentItemUpload
      • Get AssignmentItemVideo
      • Update AssignmentItemVideo
      • Get AssignmentItemZip
      • Update AssignmentItemZip
      • Create AssignmentManualReview
      • Create AssignmentReattempt
      • Create AssignmentReset
      • Create AssignmentRevocation
      • Delete AssignmentRevocation
      • Get AssignmentGroup
      • Update Assignment
      • List Assignments
    • Attempt
      • List Attempt Chartss
      • List Attempt Insights
      • 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
      • Unassign Markers
      • Get Attempt
      • Update Attempt
      • Assign 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 ExamClosure
      • List ExamClosures
      • Get ExamClosure
      • Update ExamClosure
      • Delete ExamClosure
      • Get ExamSchedule
      • Update ExamSchedule
      • Create ExamSection
      • Get ExamSection
      • Update ExamSection
      • Delete ExamSection
      • Create ExamTargetQuizSetupValidation
      • Get ExamTestTagBreakdown
      • 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
      • Update Note
      • Create Note
    • Course
      • Create CourseFolder
        POST
      • List CourseFolders
        GET
      • Get CourseFolder
        GET
      • Update CourseFolder
        PATCH
      • Delete CourseFolder
        DELETE
      • Update CourseFolder Items
        PATCH
      • Create CourseItemAudio
        POST
      • List CourseItems - use generic CourseItem
        GET
      • Get CourseItemAudio
        GET
      • Update CourseItemAudio
        PATCH
      • Delete CourseItemAudio
        DELETE
      • Create CourseItemDocument
        POST
      • List CourseItems - use generic CourseItem
        GET
      • Get CourseItemDocument
        GET
      • Update CourseItemDocument
        PATCH
      • Delete CourseItemDocument
        DELETE
      • Create CourseItemEmbed
        POST
      • List CourseItems - use generic CourseItem
        GET
      • Get CourseItemEmbed
        GET
      • Update CourseItemEmbed
        PATCH
      • Delete CourseItemEmbed
        DELETE
      • Create CourseItemNote
        POST
      • List CourseItems - use generic CourseItem
        GET
      • Get CourseItemNote
        GET
      • Update CourseItemNote
        PATCH
      • Delete CourseItemNote
        DELETE
      • Create CourseItemQuiz
        POST
      • List CourseItems - use generic CourseItem
        GET
      • Get CourseItemQuiz
        GET
      • Update CourseItemQuiz
        PATCH
      • Delete CourseItemQuiz
        DELETE
      • Create CourseItemScorm
        POST
      • List CourseItems - use generic CourseItem
        GET
      • Get CourseItemScorm
        GET
      • Update CourseItemScorm
        PATCH
      • Delete CourseItemScorm
        DELETE
      • Create CourseItemSurvey
        POST
      • List CourseItems - use generic CourseItem
        GET
      • Get CourseItemSurvey
        GET
      • Update CourseItemSurvey
        PATCH
      • Delete CourseItemSurvey
        DELETE
      • Create CourseItemTextEntry
        POST
      • List CourseItems - use generic CourseItem
        GET
      • Get CourseItemTextEntry
        GET
      • Update CourseItemTextEntry
        PATCH
      • Delete CourseItemTextEntry
        DELETE
      • Create CourseItemUpload
        POST
      • List CourseItems - use generic CourseItem
        GET
      • Get CourseItemUpload
        GET
      • Update CourseItemUpload
        PATCH
      • Delete CourseItemUpload
        DELETE
      • Create CourseItemVideo
        POST
      • List CourseItems - use generic CourseItem
        GET
      • Get CourseItemVideo
        GET
      • Update CourseItemVideo
        PATCH
      • Delete CourseItemVideo
        DELETE
      • Create CourseItemZip
        POST
      • List CourseItems - use generic CourseItem
        GET
      • Get CourseItemZip
        GET
      • Update CourseItemZip
        PATCH
      • Delete CourseItemZip
        DELETE
      • List CourseItems
        GET
      • Create Course
        POST
      • Get Course
        GET
      • Update Course
        PATCH
      • Delete Course
        DELETE
      • Reorder Course Folders
        PATCH
      • Reorder Course Items
        PATCH
    • 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 QuizQuestionVideoRecording
      • List QuizQuestionVideoRecording
      • Get QuizQuestionVideoRecording
      • Update QuizQuestionVideoRecording
      • Delete QuizQuestionVideoRecording
      • Create QuizSection
      • List QuizSections
      • Update source quizz relations on a specific Quiz.
      • Get QuizSection
      • Update QuizSection
      • Delete QuizSection
      • Update quiz section questions.
      • Add quiz section questions.
      • 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
      • Create 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
      • Create ManageBillingSession
      • Get Portal Usage
      • List Subscriptions
      • Get Subscription
    • Portal
      • Create 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
      • Create SurveyItem
      • Get SurveyItem
      • Update SurveyItem
      • Delete SurveyItem
      • Create SurveyPage
      • Get SurveyPage
      • Update SurveyPage
      • Delete SurveyPage
      • Update Survey Page Items
      • Create Survey
      • Get Survey
      • Update Survey
      • Delete Survey
      • Update Survey Pages
    • 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
      • List LegacyAccessUpgradeOptions
      • 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
      • Add Study items
      • Remove Study items
      • Create MobileUser
      • Get MobileUser
    • Exam
      • Create AttemptRevokeReversal
      • List AttemptRevokeReversals
      • Get AttemptRevokeReversal
      • Update AttemptRevokeReversal
      • Delete AttemptRevokeReversal
      • Get ExamAttemptHeadlineInsight
      • Create ExamCandidateExport
      • Get ExamHall
      • List ExamQuestionStats
      • Create ExamQuestionStatsExport
      • Create ExamV2
      • Find ExamV2s
      • Get ExamV2
      • Update ExamV2
      • Delete ExamV2
      • Create Internal Markers Group
      • Set Shared Markers Group
      • Create Internal Moderating Markers Group
      • Set Shared Moderating Markers Group
      • Set Shared Escalating Markers Group
      • Set Shared Auditing Markers Group
      • Create Internal Escalating Markers Group
      • 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
    • List AttemptResultConfigs
      GET
    • List Documents
      GET
  1. Course

List CourseItems - use generic CourseItem

Staging
https://api-stage.synap.ac/v3
Staging
https://api-stage.synap.ac/v3
GET
/course-item-note
Course

Request

None

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api-stage.synap.ac/v3/course-item-note'

Responses

🟠401Unauthorized
application/vnd.api+json
Unauthorized
Body
errors
array[object (UnauthorizedApiError) {6}] 
optional
id
string 
optional
Unique ID of this error occurrence.
status
string 
optional
HTTP status code.
code
string 
optional
Synap internal error code.
title
string 
optional
detail
string 
optional
source
object 
optional
Example
{
    "errors": [
        {
            "id": "ERR_000",
            "title": "SessionTokenException",
            "status": "401",
            "code": "209",
            "detail": "Unauthorized request."
        }
    ]
}
🟠405405
🔴501501
Previous
Create CourseItemNote
Next
Get CourseItemNote
Built with