Headless LMS
Organizations

List students

GET /api/students. List students. Headless LMS Organizations API reference.

GET
/api/students

Query Parameters

page?integer
Range1 <= value <= 9007199254740991
Default1
pageSize?integer
Range1 <= value <= 100
Default20
search?string
sort?string

Response Body

application/json

curl -X GET "https://example.com/api/students"
{  "rows": [    {      "id": "string",      "firstName": "string",      "lastName": "string",      "email": "string",      "image": "string",      "entitlementCount": -9007199254740991,      "avgProgress": -9007199254740991,      "status": "invited",      "joinedAt": "string",      "lastActiveAt": "string"    }  ],  "total": -9007199254740991,  "page": -9007199254740991,  "pageSize": -9007199254740991}

Get the caller's identity within the session's org GET

GET /api/learn/viewer. Get the caller's identity within the session's org. Headless LMS Organizations API reference.

Get a student by id GET

GET /api/students/{id}. Get a student by id. Headless LMS Organizations API reference.