- Getting Started
- Authentication
- Error Handling
- Rate Limits
- Versioning
- Security
- Proctor Integration
- API Reference
- AccessPolicy
- 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
- Authentication
- Create ADFS AuthenticationOptionPOST
- Get ADFS AuthenticationOptionGET
- Update ADFS AuthenticationOptionPATCH
- Delete ADFS AuthenticationOptionDELETE
- Create Auth0 AuthenticationOptionPOST
- Get Auth0 AuthenticationOptionGET
- Update Auth0 AuthenticationOptionPATCH
- Delete Auth0 AuthenticationOptionDELETE
- Create JWT AuthenticationOptionPOST
- Get JWT AuthenticationOptionGET
- Update JWT AuthenticationOptionPATCH
- Delete JWT AuthenticationOptionDELETE
- Get Local AuthenticationOptionGET
- Update Local AuthenticationOptionPATCH
- Create LTI1.3 AuthenticationOptionPOST
- Get LTI1.3 AuthenticationOptionGET
- Update LTI1.3 AuthenticationOptionPATCH
- Delete LTI1.3 AuthenticationOptionDELETE
- Create SAML AuthenticationOptionPOST
- Get SAML AuthenticationOptionGET
- Update SAML AuthenticationOptionPATCH
- Delete SAML AuthenticationOptionDELETE
- List AuthenticationOptionsGET
- Create BotSessionPOST
- Create PersonalAccessTokenPOST
- List PersonalAccessTokensGET
- Update PersonalAccessTokenPATCH
- Delete PersonalAccessTokenDELETE
- List PublicAuthenticationOptionsGET
- Get TokenGET
- Create ZapierApiKeyPOST
- List ZapierApiKeysGET
- Update ZapierApiKeyPATCH
- Delete ZapierApiKeyDELETE
- JobQueue
- BotUser
- Certificate
- ChartJS
- Content Management
- 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
- 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
- File
- Flag
- GenerateAccount
- Notifications
- Integrations
- Mfa
- Billing
- Portal
- Scorm
- Search
- Survey
- TipSuggestion
- 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
- MarkingEntry
- MarkingSession
- Insights
- Marking
- 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
- 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 attemptGET
List PersonalAccessTokens
Staging
Staging
GET
/personal-access-tokens
Authentication
Request
Query Params
limit
numberÂ
required
>= 1
offset
numberÂ
required
>= 0
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/personal-access-tokens?limit=&offset='
Responses
🟢200OK
application/vnd.api+json
Body
data
array[object (PersonalAccessToken) {4}]Â
required
id
stringÂ
required
Example:
FID001
type
enum<string>Â
required
Allowed value:
PersonalAccessToken
Example:
PersonalAccessToken
attributes
objectÂ
optional
relationships
objectÂ
optional
meta
objectÂ
optional
total
integerÂ
required
totalWithoutFilters
integerÂ
optional
pages
integerÂ
required
page
integerÂ
required
offset
integerÂ
required
limit
integerÂ
required
totalCount
integerÂ
deprecated
resultCount
integerÂ
deprecated
totalPages
integerÂ
deprecated
currentPage
integerÂ
deprecated
Example
{
"data": [
{
"id": "FID001",
"type": "PersonalAccessToken",
"attributes": {
"label": "string",
"createdAt": "string",
"lastUsedAt": "string",
"isRevoked": true
},
"relationships": {}
}
],
"meta": {
"total": 0,
"totalWithoutFilters": 0,
"pages": 0,
"page": 0,
"offset": 0,
"limit": 0,
"totalCount": 0,
"resultCount": 0,
"totalPages": 0,
"currentPage": 0
}
}
🟠400Bad Request
🟠401Unauthorized
🟠403Forbidden
Modified at 2025-04-17 15:00:11