Quizzes v2
API endpoints related to quizzing enhancements
GET /quizzes
Gets data for all quizzes, paginated
GET /quizzes/categories
Gets all quizzes categories even categories with the quiz is disabled or deleted
-
API Index
-
Single Sign-on
-
Approvals
GET/approvals/processes
GET/approvals/process/search/{search_phrase}
GET/approvals/process/{approval_processid}
POST/approvals/process
PATCH/approvals/process/{approval_processid}
PUT/approvals/{wikiid}/{approval_processid}
DELETE/approvals/{wikiid}
GET/approvals/requests
GET/approvals/request/{approval_requestid}
POST/approvals/request/sign/{approval_requestid}
POST/approvals/request/sign/{approval_requestid}/token
-
Authentication
-
Badges
-
Content Hierarchy
-
Media
-
Guides
GET/guides
GET/guides/featured
GET/guides/{guideid}
GET/guides/{guideid}/tags
POST/guides
PATCH/guides/{guideid}
DELETE/guides/{guideid}
POST/guides/{guideid}/{langid}/restore
PUT/guides/{guideid}/completed
DELETE/guides/{guideid}/completed
PUT/guides/{guideid}/public
DELETE/guides/{guideid}/public
POST/guides/{guideid}/steps
PATCH/guides/{guideid}/steps/{stepid}
DELETE/guides/{guideid}/steps/{stepid}
PUT/guides/{guideid}/steporder
POST/guides/steps/lines/preview
GET/guides/{guideid}/users
PUT/guides/{guideid}/users/{userid}
DELETE/guides/{guideid}/users/{userid}
GET/guides/{guideid}/teams
PUT/guides/{guideid}/teams/{teamid}
DELETE/guides/{guideid}/teams/{teamid}
GET/guides/releases
DELETE/guides/releases/{releaseid}
GET/guides/{guideid}/releases
POST/guides/releases
PATCH/guides/releases/{releaseid}
POST/guides/duplicateReleases
PUT/guides/{guideid}/tag
DELETE/guides/{guideid}/tag
GET/guides/{guideid}/approvalProcesses
-
Comments
-
Work Log
GET/work_log
GET/work_log/{entryid}
POST/work_log
POST/work_log/{entryid}/finish
POST/work_log/{entryid}/cancel
POST/work_log/{entryid}/pause
POST/work_log/{entryid}/resume
PUT/work_log/{entryid}/stepData
DELETE/work_log/{entryid}
GET/work_log/{guideid}/suspended
POST/work_log/{entryid}/suspend
POST/work_log/{entryid}/assume
-
Step Forms
-
Suggest
-
Search
-
Tags
-
Teams
-
Translation Glossary
-
Users
GET/users
GET/users/search/{search}
GET/users/searchnames/{search} (Deprecated)
GET/users/{userid}
GET/users/sso/{sso_userid}
GET/users/email/{email}
GET/users/employee_id/{employee_id}
GET/users/{userid}/badges
GET/users/{userid}/favorites/guides
GET/users/{userid}/guides
GET/users/{userid}/completions
GET/user
GET/user/badges
GET/user/favorites/guides
PUT/user/favorites/guides/{guideid}
DELETE/user/favorites/guides/{guideid}
GET/user/guides
GET/user/flags
GET/user/completions
GET/user/media/images
POST/user/media/images
DELETE/user/media/images/{imageids}
POST/user/media/images/{imageid/guid}
POST/user/media/images/edits
GET/user/media/videos
PATCH/users/{userid}
POST/users/unique_usernames
POST/users/createByEmails
-
Wikis
GET/wikis/CATEGORY?display=hierarchy
GET/wikis/{namespace}
GET/wikis/{namespace}?display=titles
GET/wikis/{namespace}/{title}
GET/wikis/{namespace}/{title}/tags
GET/wikis/CATEGORY/{title}/children
GET/wikis/CATEGORY/{title}/identification
POST/wikis
PATCH/wikis/{namespace}/{title}
DELETE/wikis/{namespace}/{title}
POST/wikis/{namespace}/{title}/revert
PUT/wikis/CATEGORY/{title}/parent
PUT/wikis/{namespace}/{title}/tag
DELETE/wikis/{namespace}/{title}/tag
POST/wikis/{wikiid}/releases
DELETE/wikis/releases/{releaseid}
-
Courses
-
Course Assignments
GET/course_assignments/{course_assignmentid}
GET/course_assignments/individualSummaries
GET/course_assignments/individualSummaries/{userid}
GET/course_assignments/teamSummaries
GET/course_assignments/teamSummaries/{teamid}
GET/course_assignments/completion/course/{wikiid}
GET/course_assignments/completion/team/{teamid}
GET/course_assignments/completion/user/{userid}
GET/course_assignments/completion/team/{$teamid}/user/{userid}
GET/course_assignments/completion/{wikiid}/{userid}
POST/course_assignments/completion/courses
POST/course_assignments/completion/teams
POST/course_assignments/completion/users
POST/course_assignments
PATCH/course_assignments/start/{doctype}/{docid}
PATCH/course_assignments/complete/{doctype}/{docid}
PATCH/course_assignments/invalidate/{doctype}/{docid}/{userid}
PATCH/course_assignments/User/completeAll/{assignee_userid}
PATCH/course_assignments/Team/completeAll/{assignee_teamid}
PATCH/course_assignments/User/invalidateAll/{assignee_userid}
PATCH/course_assignments/Team/invalidateAll/{assignee_teamid}
DELETE/course_assignments/{course_assignmentid}
GET/course_assignments/courseAssignmentDetails/{course_assignmentid}
-
User View History
-
External Training Modules
GET/external_training_modules/current
POST/external_training_modules/drafts
GET/external_training_modules/:id/usage
GET/external_training_modules/:id/player
PUT/external_training_modules/:id/current
PUT/external_training_modules/:id/draft
GET/external_training_modules/:id/imports
POST/external_training_modules/imports
POST/external_training_modules/imports/:importid/start/byUrl
POST/external_training_modules/imports/:importid/start/byUpload
POST/external_training_modules/imports/:importid/cancel
GET/external_training_modules/imports/:importid/progress
GET/external_training_modules/imports/:importid/preview
-
Quizzes
POST/quizzes/getQuizzes
POST/quizzes/import
GET/quizzes/:quizid
POST/quizzes/delete
POST/quizzes/attach/guide
POST/quizzes/attach/wiki
POST/quizzes/sessions/save
POST/quizzes/sessions/submit
POST/quizzes/sessions/cancel
GET/quizzes/submissions/:sessionid
GET/quizzes/sessions
POST/quizzes/sessions/bulkCancel
PATCH/quizzes/sessions/userInvalidateAll/:userid
-
Quizzes v2
-
Course Stage Signoffs
POST/courses/stage-sign-offs/requests
GET/courses/stage-sign-offs/requests/pending/{userid}
POST/courses/stage-sign-offs/:stage_assessmentid/signers
DELETE/stage-sign-offs/requests/:signoff_requestid
PATCH/courses/stage-sign-offs/responses
GET/courses/stage-sign-offs/responses/unacknowledged/{userid}
PATCH/courses/stage-sign-offs/responses/:signoff_requestid/acknowledge
POST/courses/stage-sign-offs/responses/:signoff_requestid/initializeViaPassword
-
Periodic Review
POST/periodic_review
DELETE/periodic_review/{prsid}
GET/periodic_review
GET/periodic_review/{prsid}
GET/periodic_review/reviews/{userid}
GET/periodic_review/documents/{userid}
POST/periodic_review/documents
DELETE/periodic_review/documents
GET/periodic_review/search/{searchTerm}
POST/periodic_review/review
GET/periodic_review/requests/{userid}
DELETE/periodic_review/documents/{prdid}
GET/periodic_review/{doctype}/{docid}
Reference Implementations
To help you get started, here are some sample open source apps that use our API:
Official Apps
- iPad (App store, Source, API v1.0)
- Android (Play store, Source, API v2.0)
- Windows Phone (Windows Phone Store, Source, API v2.0)
- WebOS (App store, Source, API v0.1)
- Embed widget (Source, API v0.1)
- Our GitHub repositories
Third-party Apps
Third-party Libraries
- JavaScript (Source, API v2.0)
- Python (Documentation, Source, API v2.0)
- PHP (Source, API v2.0)
API Versions
New applications should be developed using the latest version of the API. Please note that old versions of the API will eventually be removed. Follow our developer blog for updates.
- API v2.0 (Current version)