Headless LMS

List entitlements

GET
/api/entitlements

Query Parameters

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

Value in

  • "active"
  • "expired"
  • "revoked"
source?string
studentId?string
contentId?string
type?"course"

Value in

  • "course"

Response Body

application/json

curl -X GET "https://example.com/api/entitlements"
{  "rows": [    {      "id": "string",      "studentId": "string",      "firstName": "string",      "lastName": "string",      "studentEmail": "string",      "content": {        "id": "string",        "type": "course",        "title": "string"      },      "status": "active",      "grantedAt": "string",      "expiresAt": "string",      "source": "string"    }  ],  "total": -9007199254740991,  "page": -9007199254740991,  "pageSize": -9007199254740991}