API v2.0 - Course Assignees Documentation

GET /course_assignees/course/{wikiid}/users

Returns a paginated list of active user assignments to the given course, including metadata such as stage completion status, due date, and assignment info. Supports filtering and sorting.

Route Parameters

wikiid — Required — positive integer: The ID of the course to retrieve user assignments for.

Query Parameters

page — Optional — positive integer: Specifies the page number for paginated results. Starts at 1. Defaults to 1.
limit — Optional — positive integer: Maximum number of user assignments to return per page. Defaults to 10.
direction — Optional — enum: The sort direction. Must be either "ASC" or "DESC". Defaults to "ASC".
orderby — Optional — enum: The field used for sorting the user list. Allowed values: "username", "status", "stage_progress", "assignment_date", "due_date", "course_completion_date", "recurrence_date". Defaults to "username".
status — Optional — enum|string (comma-separated): Filter user assignments by course status. Options: "not_started", "in_progress", "completed". Supports multiple values (e.g. ?status=not_started,completed).
search — Optional — string: A search term to filter user assignments by username.

Response

Status: 200 Ok

{
    "response": [
        {
            "total_stages": 2,
            "username": "Jane Doe",
            "user_avatar": "https:\/\/www.example.com\/static\/images\/avatars\/User\/Dozuki\/single-avatar-2-01.140x105",
            "completed_stages": 1,
            "status": "In Progress",
            "course_completion_date": 1740772150,
            "assignment_date": 1740512956,
            "recurrent_date": 1740772156,
            "due_date": 1743857544
        },
        {
            "total_stages": 2,
            "username": "Steve Hor",
            "user_avatar": "https:\/\/www.example.com\/static\/images\/avatars\/User\/Dozuki\/single-avatar-2-03.140x105",
            "completed_stages": 2,
            "status": "Completed",
            "course_completion_date": 1740772150,
            "assignment_date": 1740512956,
            "recurrent_date": 1740772156,
            "due_date": 1743857544
        },
        {
            "total_stages": 2,
            "username": "Sterling Hirsh",
            "user_avatar": "https:\/\/www.dozuki.dev\/static\/images\/avatars\/User\/Dozuki\/single-avatar-2-08.thumbnail",
            "completed_stages": 0,
            "status": "Not Started",
            "course_completion_date": null,
            "assignment_date": 1741265544,
            "recurrent_date": 1741524744,
            "due_date": 1743857544
        }
    ],
    "hasMore": false,
    "totalAssignees": 1
}

GET /course_assignees/course/{wikiid}/teams

Returns a paginated list of active team assignments to the given course. Each entry includes the team, its members, and their aggregated course progress.

Route Parameters

wikiid — Required — positive integer: The ID of the course to retrieve team assignments for.

Query Parameters

page — Optional — positive integer: Specifies the page number for paginated results. Starts at 1. Defaults to 1.
limit — Optional — positive integer: Maximum number of team assignments to return per page. Defaults to 10.
direction — Optional — enum: The sort direction. Must be either "ASC" or "DESC". Defaults to "ASC".
orderby — Optional — enum: The field used for sorting the team list. Allowed values: "username", "status", "stage_progress", "assignment_date", "due_date", "course_completion_date", "recurrence_date". Defaults to "username".
search — Optional — string: A search term to filter team assignments by team name.

Response

Status: 200 Ok

{
    "response": [
        {
            "teamid": 1,
            "team_name": "Testers",
            "time_allotted": null,
            "team_assignment_date": 1742324527,
            "members_count": 2,
            "members_completed": 2,
            "avatar": "https:\/\/ioliveira.pgaletti.dozuki.dev\/igi\/ioliveira\/KKPYR6RLAdCJCGWU.thumbnail",
            "completion_percentage": 100,
            "total_stages": 2,
            "completed_stages": 2,
            "status": "Completed"
        }
    ],
    "hasMore": false,
    "totalAssignees": 1
}

GET /course_assignees/course/{wikiid}/teams/{teamid}

Returns detailed information about a team's completion progress on a course

Route Parameters

wikiid — Required — integer: The ID of the course
teamid — Required — integer: The ID of the team

Query Parameters

page — Optional — positive integer: Specifies the page number for paginated results. Starts at 1. Defaults to 1.
limit — Optional — positive integer: Maximum number of team members assignments to return per page. Defaults to 10.

Response

Status: 200 Ok

{
    "response": [
        {
            "total_stages": 2,
            "username": "Jane Doe",
            "user_avatar": "https:\/\/www.example.com\/static\/images\/avatars\/User\/Dozuki\/single-avatar-2-01.140x105",
            "completed_stages": 1,
            "status": "In Progress",
            "course_completion_date": 1740772150,
            "assignment_date": 1740512956,
            "recurrent_date": 1740772156,
            "due_date": 1743857544
        },
        {
            "total_stages": 2,
            "username": "Steve Hor",
            "user_avatar": "https:\/\/www.example.com\/static\/images\/avatars\/User\/Dozuki\/single-avatar-2-03.140x105",
            "completed_stages": 2,
            "status": "Completed",
            "course_completion_date": 1740772150,
            "assignment_date": 1740512956,
            "recurrent_date": 1740772156,
            "due_date": 1743857544
        },
        {
            "total_stages": 2,
            "username": "Sterling Hirsh",
            "user_avatar": "https:\/\/www.dozuki.dev\/static\/images\/avatars\/User\/Dozuki\/single-avatar-2-08.thumbnail",
            "completed_stages": 0,
            "status": "Not Started",
            "course_completion_date": null,
            "assignment_date": 1741265544,
            "recurrent_date": 1741524744,
            "due_date": 1743857544
        }
    ],
    "hasMore": false
}

Reference Implementations

Official Apps

Third-party Apps

Third-party Libraries

API Versions

Course Assignees

GET /course_assignees/course/{wikiid}/users

Route Parameters

Query Parameters

Response

GET /course_assignees/course/{wikiid}/teams

Route Parameters

Query Parameters

Response

GET /course_assignees/course/{wikiid}/teams/{teamid}

Route Parameters

Query Parameters

Response