Synap API
  1. Collections
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
        GET
      • Create Annotation
        POST
      • List Annotations
        GET
      • Get Annotation
        GET
      • Update Annotation
        PATCH
      • Delete Annotation
        DELETE
      • Add collection access to a user group
        POST
      • Delete collection access
        DELETE
      • Create CollectionFolder
        POST
      • List CollectionFolders
        GET
      • Get CollectionFolder
        GET
      • Update CollectionFolder
        PATCH
      • Delete CollectionFolder
        DELETE
      • Reorder CollectionFolder Items
        PATCH
      • Create CollectionSubFolder
        POST
      • Get CollectionSubFolder
        GET
      • Update CollectionSubFolder
        PATCH
      • Delete CollectionSubFolder
        DELETE
      • Reorder CollectionSubFolder Items
        PATCH
      • Create CollectionItemAudio
        POST
      • List CollectionItems - use generic CollectionItem
        GET
      • Get CollectionItemAudio
        GET
      • Update CollectionItemAudio
        PATCH
      • Delete CollectionItemAudio
        DELETE
      • Get CollectionItemDocument
        GET
      • Update CollectionItemDocument
        PATCH
      • Delete CollectionItemDocument
        DELETE
      • Create CollectionItemDocument
        POST
      • Create CollectionItemEmbed
        POST
      • List CollectionItems - use generic CollectionItem
        GET
      • Get CollectionItemEmbed
        GET
      • Update CollectionItemEmbed
        PATCH
      • Delete CollectionItemEmbed
        DELETE
      • Create CollectionItemNote
        POST
      • List CollectionItems - use generic CollectionItem
        GET
      • Get CollectionItemNote
        GET
      • Update CollectionItemNote
        PATCH
      • Delete CollectionItemNote
        DELETE
      • Create CollectionItemQuiz
        POST
      • List CollectionItems - use generic CollectionItem
        GET
      • Get CollectionItemQuiz
        GET
      • Update CollectionItemQuiz
        PATCH
      • Delete CollectionItemQuiz
        DELETE
      • Create CollectionItemVideo
        POST
      • List CollectionItems - use generic CollectionItem
        GET
      • Get CollectionItemVideo
        GET
      • Update CollectionItemVideo
        PATCH
      • Delete CollectionItemVideo
        DELETE
      • Create CollectionItemZip
        POST
      • List CollectionItems - use generic CollectionItem
        GET
      • Get CollectionItemZip
        GET
      • Update CollectionItemZip
        PATCH
      • Delete CollectionItemZip
        DELETE
      • List CollectionItems
        GET
      • List CollectionMocks
        GET
      • Create a CollectionProgress
        POST
      • List CollectionProgresses
        GET
      • Update a CollectionProgress
        PATCH
      • Get CollectionTagBreakdown
        GET
      • List Collections
        GET
      • Create Collection
        POST
      • Get Collection
        GET
      • Update Collection
        PATCH
      • Delete Collection
        DELETE
      • Reorder Collection Folders
        PATCH
      • Reorder Collection Items
        PATCH
      • Create Highlight
        POST
      • List Highlights
        GET
      • Get Highlight
        GET
      • Update Highlight
        PATCH
      • Delete Highlight
        DELETE
    • 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
  1. Collections

List Collections

Staging
https://api-stage.synap.ac/v3
Staging
https://api-stage.synap.ac/v3
GET
/collections
Collections

Request

Query Params
assignedTo
object 
required
type
enum<string> 
required
Allowed values:
usergroup
id
string 
required
limit
number 
required
>= 1
offset
number 
required
>= 0
include
array[string]
optional

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/collections?assignedTo=&limit=&offset='

Responses

🟢200OK
application/vnd.api+json
Success
Body
data
array[object (Collection) {4}] 
required
id
string 
required
The primary key for each resource.
Example:
FID001
type
enum<string> 
required
Identifies the Resource.
Allowed value:
Collection
Example:
Collection
attributes
object 
optional
relationships
object 
optional
included
array[object (GenericResource) {4}] 
optional
id
string 
optional
The primary key for each resource.
Example:
FID001
type
string 
optional
Identifies the Resource.
Example:
_User
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": "Collection",
      "attributes": {
        "createdAt": "string",
        "updatedAt": "string",
        "name": "string",
        "description": "string",
        "shortDescription": "string",
        "settings": {
          "takeTest": {},
          "playerView": {
            "enabled": true,
            "hideOverviewPage": true
          },
          "trackedProgress": {
            "enabled": true
          },
          "annotations": {
            "enabled": true
          },
          "generatedAttempts": {
            "enabled": true
          },
          "mocks": [
            {
              "id": "string",
              "title": "string",
              "filters": {},
              "quizLength": 1,
              "passScore": 0,
              "examSittingAttrs": {}
            }
          ],
          "restrictedAccess": {
            "label": "string"
          },
          "sorting": {
            "prioritise": true
          }
        },
        "attr": {},
        "extraInformation": {},
        "isArchived": true,
        "generatedAttemptsEnabled": true,
        "mocks": [
          {
            "id": "string",
            "title": "string",
            "filters": {},
            "quizLength": 1,
            "passScore": 0,
            "examSittingAttrs": {}
          }
        ],
        "annotationsEnabled": true,
        "playerViewEnabled": true,
        "playerViewHideOverviewPage": true,
        "restrictedAccessLabel": "string",
        "sortingPrioritise": true,
        "takeTestSettings": {},
        "instructionsEnabled": true,
        "instructionsTitle": "string",
        "instructionsBody": "string",
        "instructionsTimerDurationMs": 1,
        "instructionsEnforcedTimer": "afterAudioStarts",
        "instructionsAudioAutoAdvance": "disabled",
        "instructionsAudioAutoAdvanceDelayMs": 0,
        "instructionsAudioAutoPlay": true,
        "instructionsDisableAudioControls": true,
        "markingCreditsPerQuestion": 0,
        "markingPartialCreditsPerQuestion": 0,
        "markingPenaltiesPerQuestion": 0,
        "markingPenaltiesEnabled": true,
        "grades": [
          {
            "label": "string",
            "minScore": 0,
            "isPass": true,
            "description": "string"
          }
        ],
        "allowedModes": [
          "practice"
        ],
        "allowedLengths": [
          "default"
        ],
        "allowedPlayers": [
          "default"
        ],
        "allowedTagSets": [
          "string"
        ],
        "allowedFacets": [
          "subject"
        ],
        "calculatorEnabled": true,
        "tagSelectionDisplayMode": "dropdown",
        "allowMultipleTagSelection": true,
        "excludeUntaggedQuestions": true,
        "showMasteryFilters": true,
        "calculatorType": "basic",
        "securityDisableCopying": true,
        "securityDisablePasting": true,
        "securityDisableRightClick": true,
        "navigationDisableNavigation": true,
        "navigationDisableControlPanel": true,
        "navigationDisableNotifications": true,
        "softSectionsEnabled": true,
        "shuffleSectionsEnabled": true,
        "shuffleQuestions": "disabled",
        "notepadEnabled": true,
        "strikethroughEnabled": true,
        "highlightingEnabled": true,
        "bookmarkingEnabled": true,
        "micSettingsEnabled": true,
        "labValuesEnabled": true,
        "labValuesHtml": "string",
        "resumeLaterButtonEnabled": true,
        "flaggingEnabled": true,
        "showAvailableMarks": true,
        "playerType": "default",
        "theme": "string",
        "fontSize": "xSmall",
        "pinnedMessageDuringTest": "string",
        "resultsMessageCompleted": "string",
        "resultsMessageSettingHideTitle": true,
        "resultsMetricScoreEnabled": true,
        "resultsMetricTimeSpentEnabled": true,
        "resultsMetricGradeEnabled": true,
        "resultsMetricQuestionBreakdownDisplayLevel": "full",
        "resultsMetricAnalyticsCohort": "exam",
        "resultsMetricCohortAverageEnabled": true,
        "resultsMetricCohortPercentileEnabled": true,
        "resultsMetricCohortScoreDistributionEnabled": true,
        "resultsMetricTagBreakdownEnabled": true,
        "resultsMetricTagProgressEnabled": true,
        "resultsMetricTagProgressFacetsEnabled": {
          "subject": true,
          "topic": true,
          "subtopic": true,
          "skill": true,
          "difficulty": true
        },
        "resultsEducatorViewAsAdminEnabled": true,
        "timerEnabled": true,
        "timerHidden": true,
        "timerUseQuestions": true,
        "timerUseSections": true,
        "timerEnforceFullTime": true,
        "timerTimeInMs": 1,
        "timerExtraTimeMultiplier": 0,
        "timerSoftTimer": true,
        "trackedProgressEnabled": true
      },
      "relationships": {
        "owner": {
          "data": {
            "id": "FID001",
            "type": "User"
          }
        },
        "subPortal": {
          "data": {
            "id": "FID001",
            "type": "SubPortal"
          }
        },
        "items": {
          "data": [
            {
              "id": "FID001",
              "type": "CollectionItem"
            }
          ]
        },
        "folders": {
          "data": [
            {
              "id": "FID001",
              "type": "CollectionFolder"
            }
          ]
        },
        "icon": {
          "data": {
            "id": "FID001",
            "type": "File"
          }
        },
        "coverImage": {
          "data": {
            "id": "FID001",
            "type": "File"
          }
        },
        "collectionAccess": {
          "data": [
            {
              "id": "FID001",
              "type": "CollectionAccess"
            }
          ]
        },
        "instructionsAudio": {
          "data": {
            "id": "FID001",
            "type": "File"
          }
        }
      }
    }
  ],
  "included": [
    {
      "id": "FID001",
      "type": "_User",
      "attributes": {},
      "relationships": {
        "property1": {
          "data": {
            "id": "FID001",
            "type": "_User"
          },
          "links": {
            "self": "string",
            "related": "string"
          },
          "meta": {}
        },
        "property2": {
          "data": {
            "id": "FID001",
            "type": "_User"
          },
          "links": {
            "self": "string",
            "related": "string"
          },
          "meta": {}
        }
      }
    }
  ],
  "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
Previous
Get CollectionTagBreakdown
Next
Create Collection
Built with