Get Course Enrollments

Description

 Get all enrollments for a given course.

URL

https://portal.phishingbox.com/api/v1/Courses/courseEnrollments?id=:id

Method

GET

URL Params

Required:

id=[alphanumeric]

Example: id=f593e4c1-725b-4045-a0f5-3e25e55b6ba4

Description: The course uuid.

Optional:

limit=[integer]

Example: limit=100

Description: The record limit.

offset=[integer]

Example: offset=100

Description: The record offset.

POST Params

N/A

HTTP Headers

api-token: {api_token}

Success Response

Code: 200

{
    "response_code": 200,
    "success": true,
    "data": {
        "course": {
            "uuid": "f593e4c1-725b-4045-a0f5-3e25e55b6ba4",
            "date_created": "2020-01-31 09:21:52",
            "date_updated": "2020-01-31 11:23:16",
            "name": "Example Course",
            "description": "<p>Example course description</p>",
            "is_scorm": "0",
            "course_difficulty": "loose",
            "content_type": "videoLink",
            "content_value": "https://www.example.com/course-video",
            "pass_threshold": "0"
        },
        "count": 222,
        "prev": "https://portal.phishingbox.com/api/v1/Courses/courseEnrollments?&offset=0&limit=100",
        "curr": "https://portal.phishingbox.com/api/v1/Courses/courseEnrollments?&offset=100&limit=100",
        "next": "https://portal.phishingbox.com/api/v1/Courses/courseEnrollments?&offset=200&limit=100",
        "last": "https://portal.phishingbox.com/api/v1/Courses/courseEnrollments?&offset=200&limit=100",
        "enrollments": [
            {
                "target_uuid": "514fb59f-4616-4d1d-d71b-619bac237b46",
                "first_name": "John",
                "last_name": "Doe",
                "email": "john.doe@example.com",
                "is_active": "Yes",
                "date_enrolled": "2020-03-10 08:12:51",
                "date_course_started": "2020-03-19 14:52:55",
                "date_due": "2020-05-30 00:00:00",
                "percent_complete": "100",
                "course_step": "2",
                "score": "75",
                "tries": "1",
                "time": "636"
            },
            {
                "target_uuid": "413fb59f-4616-4d1c-c71b-619bac237e46",
                "first_name": "Jane",
                "last_name": "Doe",
                "email": "jane.doe@example.com",
                "is_active": "Yes",
                "date_enrolled": "2020-03-19 14:52:55",
                "date_course_started": null,
                "date_due": "2020-05-30 00:00:00",
                "percent_complete": "0",
                "course_step": "1",
                "score": "0",
                "tries": "0",
                "time": "0"
            },
            "..."
        ]
    }
}

Error Response

Code: 401 Unauthorized

Content:

{
    "response_code":401,
    "success":false,
    "error_message":"Invalid API user token",
    "data":[]
}

Code: 403 Unauthorized

Content:

{
    "response_code":403,
    "success":false,
    "error_message":
    "API Accessed from Unauthorized Location",
    "data":[]
}

Notes

 The record limit is capped at 100 records per call.

cURL Example

 curl --location --request GET 'https://portal.phishingbox.com/api/v1/Courses/courseEnrollments?id=b8002e67-c40f-4eb4-b9ba-b13ff91ed0b3' \
--header 'api-token: 2c4763d7c10e1194c0070c7c17ab288823055edb' \