Flourish QMS

API reference / Enrolments

List your organization's enrolments

GET/v1/enrolments

Needs a bearer access token with the enrolments.read scope. How authentication works

Who from your organization is enrolled in what, their progress status, and when they finish (or finished). Filter by status or a specific user_id to narrow it down — e.g. status=completed for a compliance report of everyone who's finished mandatory training.

Query parameters

  • statusstringquery

    Only return enrolments with this status.

    Allowed values:in_progresscompleted

  • user_idstring · uuidquery

    Only return enrolments for this learner.

  • limitintegerquery

    Page size. Default 25, maximum 100.

  • offsetintegerquery

    How many results to skip before the first one returned. Maximum 10,000.

Responses

  • 200A page of enrolments
    Response fields
    • dataarray of Enrolment
      • idstring · uuid
      • user_idstring · uuid
      • course_idstring · uuid
      • statusstring

        Allowed values:in_progresscompleted

      • enrolled_atstring · date-time
      • completed_atstring · date-timenullable
      • access_expires_atstring · date-timenullable
    • totalinteger