Flourish QMS

API reference / Learners

List your organization's learners

GET/v1/users

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

Everyone currently on your organization's own learner list — never another organization's. Useful for looking up a user_id to filter /v1/enrolments or /v1/certificates by, or just to check who's already in Florisage before calling POST /v1/enrolments for them.

Query parameters

  • 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 users
    Response fields
    • dataarray of User
      • idstring · uuid
      • emailstring
      • first_namestring
      • last_namestring
      • mobilestringnullable
      • rolestring
      • statusstring
      • organization_idstring · uuidnullable
      • created_atstring · date-time
    • totalinteger