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}

GET/approvals/request/{approval_requestid}

POST/approvals/request/sign/{approval_requestid}

POST/approvals/request/sign/{approval_requestid}/token

Authentication

Badges
- ```
GET/badges
```
- ```
GET/badges/{badgeid}
```

Step Forms

```
GET/step_forms/stepid/{stepid}
```

GET/step_forms/form_revisionid/{form_revisionid}

GET/step_forms/field_revisionid/{field_revisionid}

Translation Glossary

DELETE/translation_glossary/entries/{entryid}

Users

GET/users/searchnames/{search} (Deprecated)

Wikis

GET/wikis/CATEGORY/{title}/identification

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

```
GET/user_view_history/user/{userid}
```

GET/user_view_history/{doc_type}/{docid}

External Training Modules

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

PATCH/quizzes/sessions/userInvalidateAll/:userid

Quizzes v2
- ```
GET/quizzes
```
- ```
GET/quizzes/categories
```

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

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

JavaScript app (Example, Source, API v2.0)
Repairability Score Table (Example, Source, API v2.0)

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)

Translation Glossary

Get, add, modify, and delete entries from the translation glossary. The translation glossary is used to specify entries and how they should be translated per language. These endpoints are only available for sites with multiple languages.

GET /translation_glossary/entries

List of glossary entries. This endpoint currently returns all entries in the glossary.

PUT /translation_glossary/entries

Add, modify, and/or delete entries for the Translation Glossary.

Request Body

entries — Optional — array of objects

List of entries to add and/or modify.

entryid— Optional integer. The entryid of an existing entry that is being edited. If unspecified or set to null then the entry will be considered new. The response body includes the same entries that were added/modified in the same order. Any new entries will have the entryid included in the response.
translations— Required array of objects. The translations per language of the entry. Each translation has two required fields: `langid` (string) and `text` (string). If an entryid is provided, all translations of the entry will be overwritten with the given new list of translations. Each entry must contain an English (`en`) translation.

Example

{
    "entries": [
        {
            "entryid": 1,
            "translations": [
                {
                    "langid": "en",
                    "text": "Hello"
                },
                {
                    "langid": "es",
                    "text": "Hola"
                }
            ]
        },
        {
            "translations": [
                {
                    "langid": "en",
                    "text": "New"
                },
                {
                    "langid": "es",
                    "text": "Nuevo"
                }
            ]
        }
    ]
}

deletedEntryids — Optional — array of integers

List of entryids that will be deleted.

Example

{
    "deletedEntryids": [
        123,
        456
    ]
}

Response

Status: 200 OK

{
    "entries": [
        {
            "entryid": 1,
            "translations": [
                {
                    "langid": "en",
                    "text": "Hello"
                },
                {
                    "langid": "es",
                    "text": "Hola"
                }
            ]
        },
        {
            "entryid": 2,
            "translations": [
                {
                    "langid": "en",
                    "text": "New"
                },
                {
                    "langid": "es",
                    "text": "Nuevo"
                }
            ]
        }
    ],
    "deletedEntryids": [
        123,
        456
    ]
}

DELETE /translation_glossary/entries/{entryid}

Delete an entry from the Translation Glossary. If you want to delete individual translations of an entry, use the PUT /translation_glossary/entries endpoint and specify a new list of translations that you want.

Reference Implementations

Official Apps

Third-party Apps

Third-party Libraries

API Versions

Translation Glossary

GET /translation_glossary/entries

Response

PUT /translation_glossary/entries

Request Body

Response

DELETE /translation_glossary/entries/{entryid}

Route Parameters

Response