List Enrollments - MSAAQ Documentation

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

filters[course_id]

integer

optional

Internal filter used to restrict data by a specific course.

filters[member_id]

integer

optional

Internal filter used to target records associated with a specific member.

filters[member_status]

enum<string>

optional

Filters the results based on the current status of the member (e.g., active/inactive in the system).

Allowed values:

activeinactive

filters[email_verified]

enum<string>

optional

Filters records based on whether the member’s email has been verified.

Allowed value:

yes

filters[member_created_at]

enum<string> <e>

optional

Filters members based on when they joined the platform.

Allowed values:

last_weeklast_monthlast_year

filters[attendance_status]

enum<string>

optional

Filters members based on their attendance status for the selected course and chapter.

Allowed values:

attendednot_attended

Header Params

Accept

string

required

Example:

application/json

X-Tenant

string

required

Example:

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location -g --request GET 'https://api.msaaq.com/v1/admin/enrollments?filters[course_id]&filters[member_id]&filters[member_status]&filters[email_verified]&filters[member_created_at]&filters[attendance_status]' \
--header 'Accept: application/json' \
--header 'X-Tenant: academy.msaaq.com' \
--header 'Content-Type: text/plain' \
--data-raw ''

Responses

🟢200Success

application/json

Body

data

array[object (Enrollment) {7}]

required

id

integer

required

last_viewed

object

required

percentage_completed

null

required

started_at

null

required

created_at

string

required

completed_at

null

required

qr_code_link

string

optional

Example

{
    "data": [
        {
            "id": 0,
            "last_viewed": {
                "chapter_id": 0,
                "content_id": 0
            },
            "percentage_completed": null,
            "started_at": null,
            "created_at": "string",
            "completed_at": null,
            "qr_code_link": "string"
        }
    ]
}