Skip to main content

Get eLearning learner details with the REST API

Use the eLearning API to return details, in JSON format, about an eLearning user for a specified user ID. For a list of user IDs in your organization, use the learners endpoint.

Resource URL{user_id}


NameQuery or Path ParameterTypeDescription
user_id *
PathStringeLearning user unique identifier.

HTTP codes

HTTP CodeDescriptionType
200Success. Returns an eLearning user for the specified ID.Learner
400Invalid request.Null
401Unauthorized request.Null
403Access denied.Null
500Server side error.Null

Example request

This example assumes you have correctly configured your credentials and configured any required HMAC authentication libraries.


import org.apache.http.HttpEntity;
import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;
import org.json.JSONObject;


public class GetLearnerClient {

// An API Id for authentication
private final static String API_KEY = "API_KEY_GOES_HERE";

// The secret key corresponding to the API Id
private final static String API_SECRET = "API_SECRET_GOES_HERE";

public static void main(String[] args) throws Exception {

URI uri = URI.create("");
String authHeader = ClientCryptoLib.calculateAuthorizationHeader(ClientCryptoLib.VERACODE_HMAC_SHA_256, API_KEY,
API_SECRET, uri.getHost(), uri.getPath(), HttpGet.METHOD_NAME);

HttpGet request = new HttpGet(uri);
request.addHeader("Authorization", authHeader);

CloseableHttpResponse response = HttpClients.createDefault().execute(request);
HttpEntity entity = response.getEntity();
JSONObject json = new JSONObject(EntityUtils.toString(entity, "UTF-8"));


Example response

This example response conforms to the Hypertext Application Language content type application/hal+json, which includes a link to the reportcards endpoint for the given user.

HTTP/1.1 200 OK
Content-Type: application/json
"firstName": "John",
"lastName": "Smith",
"lastLogin": "2018-05-11T19:23:28.027Z",
"_embedded": {
"curricula": [
"curriculumName": "AllReqd"
"_links": {
"reportcards": {
"templated": true,
"href": "{&course_id,page,size}"
"self": {
"href": ""
"userId": "jsmith",
"email": "[email protected]"