Course External

Structure for customer-facing course external endpoints. The URL base is /api/2.0/courses/external. Private endpoints support existing authentication via persistent API tokens using Authorization: api AUTHTOKEN or a logged-in browser session. API tokens can be managed from the site's API settings.

GET /courses/external/health

Returns a minimal health response for the course external API route.

GET /courses/external/course_stage_completions/history

Returns paginated historical course stage completion events from course_stage_completion_events. Results are driven by the event table and do not require a live course_stage_completions row. Disabled users, unassigned users, and removed stages are included when historical events exist. Enrichment data such as assignment, document completion, manager override, quiz, and signoff details is nullable.

Query Parameters

courseids — Optional — integer|string (comma-separated): Filter by course IDs. Maps to course_stage_completion_events.wikiid.
userids — Optional — integer|string (comma-separated): Filter by user IDs. Maps to course_stage_completion_events.userid.
to_status — Optional — string (comma-separated): Filter by the status the event transitioned to. Supported values: pending, started, completed, expired, invalidated, blocked, and N/A. Maps to course_stage_completion_events.to_status.
from_status — Optional — string (comma-separated): Filter by the status the event transitioned from. Supported values: pending, started, completed, expired, invalidated, blocked, and N/A. Maps to course_stage_completion_events.from_status.
user_status — Optional — enum: Filter by current user status. Supported values: active, disabled.
occurred_at_start_date — Optional — integer: Filter events that occurred at or after this Unix timestamp. Maps to course_stage_completion_events.occurred_at.
occurred_at_end_date — Optional — integer: Filter events that occurred at or before this Unix timestamp. Maps to course_stage_completion_events.occurred_at.
limit — Optional — positive integer: Maximum number of events to return. Defaults to 50. Maximum is 100.
offset — Optional — non-negative integer: Zero-based row offset for pagination. Defaults to 0.

Response

Status: 200 OK

{
    "response": [
        {
            "course_stage_completion_eventid": 1234,
            "course_id": 444,
            "course_stageid": 829,
            "user_course_assignmentid": 252,
            "userid": 520,
            "wiki_revisionid": 9001,
            "course_doc_completionid": 7172,
            "occurred_at": 1734364303,
            "current_status": "completed",
            "from_status": "pending",
            "to_status": "started",
            "from_status_reason": "doc_in_progress",
            "to_status_reason": "completed",
            "time_in_from_status": 1097,
            "source": "system",
            "course": {
                "course_id": 444,
                "title": "Pulse Display"
            },
            "user": {
                "userid": 520,
                "username": "tester092312",
                "email": "myusername@test.com",
                "status": "active",
                "active": true
            },
            "stage": {
                "course_stageid": 829,
                "orderby": 0,
                "doctype": "guide",
                "docid": 4,
                "strictness": null,
                "frequency_quantity": null,
                "frequency_unit": null
            },
            "assignment": {
                "user_course_assignmentid": 252,
                "course_assignment_stageid": 990,
                "created_date": 1734363206,
                "deadline": null,
                "last_completed_at": 1734364303,
                "due_date": 1734968000
            },
            "document_completion": {
                "course_assignment_stage_completionid": 7172,
                "init_date": 1734363206,
                "end_date": 1734364303,
                "work_log_entryid": null
            },
            "manager_override": null,
            "quiz": null,
            "signoff": null
        }
    ],
    "pagination": {
        "page": 1,
        "limit": 50,
        "offset": 0,
        "has_more": false,
        "total": 1
    }
}

Reference Implementations

Official Apps

Third-party Apps

Third-party Libraries

API Versions

Course External

GET /courses/external/health

Response

GET /courses/external/course_stage_completions/history

Query Parameters

Response