Activity Player Templates endpoint
Manage the Activity assessment player templates in your Item bank.
Endpoints:
Usage
The format of requests to the Data API use the following syntax:
https://data.learnosity.com/{LTS_VERSION}/{endpoint}
For example, to use the v2025.1.LTS version and the itembank/items endpoint, you would create a request like so:
https://data.learnosity.com/v2025.1.LTS/itembank/items
Important Data API is not a REST API. All requests must use the POST method with the action request body parameter specifying the operation to use. The Learnosity SDK must be used to make requests to Data API.
Note Data API usage is subject to rate limits.
Related articles:
- Getting Started with the Data API
- See Release Cadence and Version Lifecycle for more information on available LTS versions.
Get Activity Player Templates
Retrieve all Activity assessment player templates for a specific Item bank.
You would want to use this to retrieve all assessment player templates to review the layout, settings, and label bundles which have been configured.
See Custom Assessment Player Templates for more information.
| Endpoint | /{LTS_VERSION}/itembank/playertemplates |
|---|---|
| HTTP method | POST |
| Action type | "get" |
Request body parameters
Body content type: application/json
-
organisation_id integer
Specifies the Item bank to retrieve Item pools from.
The API consumer making the request will need to have access to the Item bank. This access can be checked via the API consumers configuration in the Learnosity Console.
Default: the primary Item bank associated with the API consumer.
Request body example
// No parameters applicable. The endpoint always returns all Activity player templates.
{}
Responses
Response example
{
"meta": {
"status": true,
"timestamp": 1633504859,
"records": 1
},
"data": [
{
"name": "Test Player Template",
"reference": "980fe27e-b0e4-4b18-bb32-f036921ca1ea",
"json": {
"regions": {
"top-left": [
{ "type": "title_element" },
{ "type": "save_button" }
],
"top-right": [
{
"type": "pause_button",
"position": "right"
},
{ "type": "timer_element" },
{ "type": "reading_timer_element" },
{ "type": "itemcount_element" }
],
"right": [
{ "type": "verticaltoc_element" },
{ "type": "fullscreen_button" },
{ "type": "reviewscreen_button" },
{ "type": "resource_button" },
{ "type": "accessibility_button" },
{ "type": "calculator_button" },
{ "type": "flagitem_button" },
{ "type": "notepad_button" },
{ "type": "stickynote_add_button" },
{ "type": "stickynote_visibility_button" },
{ "type": "drawing_mode_button" },
{ "type": "drawing_visibility_button" }
],
"bottom-right": [
{ "type": "next_button" },
{ "type": "previous_button" }
],
"items": [
{
"type": "slider_element",
"scrollable_option": false
}
]
},
"labelBundle": {
"actionsave": "Commit"
},
"custom_data": {
"custom_key": "some_value"
}
}
}
]
}
Get Activity Base Templates - Deprecated
This endpoint has been deprecated.
Activity Base Templates have been deprecated in favor of Player Templates - migrate and use GET /itembank/playertemplates instead for LTS versions higher than v2022.1.LTS. See the migration guide for more information.
No parameters (bar Organisation ID) applicable. The endpoint always returns all Activity base templates.
| Endpoint | /{LTS_VERSION}/itembank/activities/templates |
|---|---|
| HTTP method | POST |
| Action type | "get" |
Request body parameters
Body content type: application/json
-
organisation_id integer
Specifies the Item bank to retrieve Item pools from.
The API consumer making the request will need to have access to the Item bank. This access can be checked via the API consumers configuration in the Learnosity Console.
Default: the primary Item bank associated with the API consumer.
Request body example
// No parameters applicable. The endpoint always returns all Activity templates.
{}
Responses
Response example
{
"meta": {
"status": true,
"timestamp": 1408491907,
"records": 3
},
"data": [
{
"reference": "BASETEMPLATE_1",
"data": {
"config": {
"ui_style": "main",
"navigation": {
"show_title": true,
"show_itemcount": true,
"show_fullscreencontrol": false,
"toc": true,
"auto_save": {
"save_interval_duration": 300
}
}
}
},
"description": "base_1",
"status": "archived"
},
{
"reference": "BASETEMPLATE_2",
"data": {
"config": {
"ui_style": "main",
"navigation": {
"show_title": true,
"toc": true
},
"title": "base_2 title",
"subtitle": "base_2 subtitle"
}
},
"description": "base_2",
"status": "published"
},
{
"reference": "BASETEMPLATE_3",
"data": {
"config": {
"ui_style": "horizontal",
"navigation": {
"show_title": false,
"toc": false
},
"title": "base_3 title",
"subtitle": "base_3 subtitle"
}
},
"description": "base_3",
"status": "published"
}
]
}