Flourish QMS

API reference / Learners

Retrieve a learner

GET/v1/users/{id}

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

One learner from your own organization, by id. An id belonging to a different organization, or that isn't a learner at all, returns 404.

Path parameters

  • idstring · uuidpathrequired

    The learner's id.

Responses

  • 200The user
    Response fields
    • dataUser
      • idstring · uuid
      • emailstring
      • first_namestring
      • last_namestring
      • mobilestringnullable
      • rolestring
      • statusstring
      • organization_idstring · uuidnullable
      • created_atstring · date-time
  • 404Not found
    Example response
    {
      "error": {
        "code": "not_found",
        "message": "Not found."
      }
    }