With the GET API connector, clients can retrieve user data, including module completion, test results, scores, course completion, and phishing data. The API key and API secret are generated in Edit organisation and provide an encrypted connection.

Please note: this functionality requires a Freedom licence.

Implementing the GET API connector offers several advantages. It allows you to efficiently extract user data, saving time and effort. In addition, it enables seamless integration with other platforms, improving the overall experience.

The configuration can be found in the menu Edit organisation.

Example configuration

Course completed by date by user

Path: https://portal.2lrn4.com/api/courses

Header:
api_key
api_secret

Parameters:
date_from (optional, string, format: \"Y-m-d\")
date_to (optional, string, format: \"Y-m-d\")
users (optional, array)

Response (example):
{
  \"status\": \"success\",
  \"message\": \"Complete courses\",
  \"data\": [
    {
      \"name\": \"John Doe\",
      \"email\": \"john@mail.test\",
      \"complete_courses\": [
        {
          \"course\": \"Test Course\",
          \"start_at\": \"2023-01-01\",
          \"end_at\": \"2023-01-01\",
          \"complete_at\": \"2023-01-01\"
        }
      ]
    }
  ]
}