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
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
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
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}
GET/user/media/videos
PATCH/users/{userid}
POST/users/unique_usernames
POST/users/createByEmails
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
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
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
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}
To help you get started, here are some sample open source apps that use our API:
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.
Badges are awarded to users for performing specific actions on the site. Some badges can be earned twice while others can only be earned once.
List badges alphabetically.
The number of badges to skip from the beginning. Range: [0, infinity). Defaults to 0.
The maximum number of badges to include in the response. Range: [1, 200]. Defaults to 20.
Status: 200 OK
[ { "badgeid": 63, "category": "badgeGuide", "description": "Successfully follow a guide", "multiple": false, "name": "Novice Repairman", "num_users": 28332, "type": "bronze" }, { "badgeid": 12, "category": "badgeAnswers", "description": "Question with 500 views", "multiple": true, "name": "Popular Question", "num_users": 13146, "type": "silver" }, { "badgeid": 37, "category": "badgeGuide", "description": "Start a guide that gets 500 views", "multiple": true, "name": "Initiator", "num_users": 5536, "type": "bronze" }, { "badgeid": 73, "category": "badgeGeneral", "description": "Write a story", "multiple": false, "name": "Storyteller", "num_users": 5161, "type": "bronze" }, { "badgeid": 2, "category": "badgeAnswers", "description": "Ask first question with an up vote", "multiple": false, "name": "Student", "num_users": 4418, "type": "bronze" } ]
Returns detailed information about the requested badge and a list of users who have earned that badge.
The badgeid of the badge to return. Can be obtained from a call to /api/badges
The number of users to skip from the beginning. Range: [0, infinity). Defaults to 0.
The maximum number of users to include in the response. Range: [1, 200]. Defaults to 20.
Status: 200 OK
{ "badge": { "badgeid": 73, "category": "badgeGeneral", "description": "Write a story", "multiple": false, "name": "Storyteller", "num_users": 5161, "type": "bronze" }, "users": [ { "date": 1326914829, "times_earned": 1, "userid": 4, "username": "Luke Soules" }, { "date": 1323199850, "times_earned": 1, "userid": 303, "username": "jonathanbruck" }, { "date": 1340739054, "times_earned": 1, "userid": 528, "username": "Kenny" }, { "date": 1318274646, "times_earned": 1, "userid": 777, "username": "dangold" }, { "date": 1313177027, "times_earned": 1, "userid": 1564, "username": "ptrillides" } ] }