{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"dc394176-596e-4edd-a3f1-7cb41ffb50e2","name":"Learning Platform API","description":"# Learning Platform API Documentation\n\nWelcome to the Learning Experience Platform API. This collection provides access to both our **Simple API** (for basic provisioning integrations) and **Full LXP API** (for complete platform functionality).\n\n---\n\n## Quick Start\n\n### Which API Should I Use?\n\n| If you need to... | Use |\n|-------------------|-----|\n| Simple user provisioning from an external system | Simple API |\n| Basic group and tag management | Simple API |\n| Simple course enrollments | Simple API |\n| Sync course completions to your HRIS | Simple API |\n| Manage users, courses, and learning content | Full LXP API |\n| Work with assessments, badges, or skills | Full LXP API |\n| Manage events and scheduling | Full LXP API |\n| Configure organisation settings | Full LXP API |\n\n### Need High-Volume Provisioning?\n\nFor enterprise-scale user provisioning with support for:\n- High-load data ingestion\n- Job roles and manager hierarchies\n- Full organisational frameworks (positions, departments, etc.)\n\nSee the **[Learning Pool Provisioning API](https://provisioning-apidocs.learningpool.com/)** - a separate brokered API system designed for bulk data operations. This requires separate configuration and API keys, available from your Learning Pool account manager on request.\n\n---\n\n## Authentication Overview\n\nThis collection uses **two different authentication systems**:\n\n| API | Auth Type | Token Variable | Folder |\n|-----|-----------|----------------|--------|\n| Simple API | OAuth 2.0 | `{{accessToken}}` | `[2] Simple API` |\n| Full LXP API | JWT | `{{bearerToken}}` | `[3] Full LXP API` |\n\n**Important:** Each API folder has folder-level authentication configured. All requests within a folder automatically inherit the correct token.\n\n---\n\n## Simple API Authentication (OAuth 2.0)\n\nThe Simple API uses OAuth 2.0 client credentials flow. This is ideal for server-to-server integrations.\n\n### Setup\n\n1. Set your environment variables:\n   - `baseURL`: Your platform instance (e.g., `https://learningplatform.customer.com`)\n   - `client`: Your OAuth client ID\n   - `secret`: Your OAuth client secret\n\n2. Run the **Request OAuth Access Token** request in `[1] Authentication & Setup > Simple API (OAuth)`\n\n3. The `{{accessToken}}` variable will be automatically populated\n\n4. All requests in the `[2] Simple API` folder will now work\n\n### Token Refresh\n\nOAuth tokens expire after 1 hour. Run the token request again when you receive a `401 Unauthorized` response.\n\n---\n\n## Full LXP API Authentication (JWT)\n\nThe Full LXP API uses JSON Web Tokens (JWT) for user-authenticated requests.\n\n### Method 1: Username/Password (Interactive Users)\n\nFor applications where users log in with their credentials:\n\n1. Set `userUsername` and `userPassword` in your environment\n2. Run **Generate User JWT** in the Authentication folder\n3. The `{{bearerToken}}` will be populated\n\n### Method 2: OAuth Token Exchange (Server-to-Server)\n\nFor backend integrations that need to act on behalf of a user:\n\n1. First, obtain an OAuth `{{accessToken}}` (see Simple API above)\n2. Set `userId` to the target user's ID\n3. Run **Generate User JWT (OAuth Exchange)**\n4. The `{{bearerToken}}` will be populated for that user\n\n### Method 3: Session Cookie (Browser-Based)\n\nFor browser applications where users are already logged in:\n\n1. Run **Get JWT Token Cookie** (requires active browser session)\n\n---\n\n## Environment Variables\n\n| Variable | Required | Description |\n|----------|----------|-------------|\n| `baseURL` | Yes | Your platform instance URL |\n| `client` | For OAuth | OAuth client ID |\n| `secret` | For OAuth | OAuth client secret |\n| `accessToken` | Auto | Populated by OAuth request |\n| `bearerToken` | Auto | Populated by JWT request |\n| `userUsername` | For Method 1 | User's login username |\n| `userPassword` | For Method 1 | User's login password |\n| `userId` | For Method 2 | Target user ID for token exchange |\n| `organisationId` | Optional | Organisation ID for admin operations |\n\n---\n\n## Error Responses\n\n| Code | Description |\n|------|-------------|\n| `400` | Bad Request - Invalid parameters |\n| `401` | Unauthorized - Token missing or expired |\n| `403` | Forbidden - Insufficient permissions |\n| `404` | Not Found - Resource doesn't exist |\n| `422` | Validation Error - Check request body |\n| `500` | Server Error - Contact support |\n\n---\n\n## Support\n\nFor API access, integration support, or technical questions, contact your Learning Platform account representative.\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"10165930","team":102197,"collectionId":"dc394176-596e-4edd-a3f1-7cb41ffb50e2","publishedId":"2sBXcDFgZe","public":true,"publicUrl":"https://platform-apidocs.learningpool.com","privateUrl":"https://go.postman.co/documentation/10165930-dc394176-596e-4edd-a3f1-7cb41ffb50e2","customColor":{"top-bar":"FFFFFF","right-sidebar":"7e7e7e","highlight":"0077cc"},"documentationLayout":"classic-single-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/4d0a3833-5c38-4d7a-a2b5-8fc3d04f27a7/NDVhYzQ5Nzc2MWQ4ZTQxYzIyMTUyYjFlYzRhMjEzZGQ0YWVjOTBmMzllZDM3YjE5OTVhNWQ3ZjhlOGU4ZWI0ZS5wbmc=","colors":{"top-bar":"212121","right-sidebar":"7e7e7e","highlight":"0077cc"}},{"name":"light","logo":"https://content.pstmn.io/4d0a3833-5c38-4d7a-a2b5-8fc3d04f27a7/NDVhYzQ5Nzc2MWQ4ZTQxYzIyMTUyYjFlYzRhMjEzZGQ0YWVjOTBmMzllZDM3YjE5OTVhNWQ3ZjhlOGU4ZWI0ZS5wbmc=","colors":{"top-bar":"FFFFFF","right-sidebar":"7e7e7e","highlight":"0077cc"}}]}},"version":"8.10.1","publishDate":"2026-02-17T11:09:26.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":"https://content.pstmn.io/4d0a3833-5c38-4d7a-a2b5-8fc3d04f27a7/NDVhYzQ5Nzc2MWQ4ZTQxYzIyMTUyYjFlYzRhMjEzZGQ0YWVjOTBmMzllZDM3YjE5OTVhNWQ3ZjhlOGU4ZWI0ZS5wbmc=","logoDark":"https://content.pstmn.io/4d0a3833-5c38-4d7a-a2b5-8fc3d04f27a7/NDVhYzQ5Nzc2MWQ4ZTQxYzIyMTUyYjFlYzRhMjEzZGQ0YWVjOTBmMzllZDM3YjE5OTVhNWQ3ZjhlOGU4ZWI0ZS5wbmc="}},"statusCode":200},"environments":[{"name":"Learning Platform Environment","id":"17fed4b1-d05f-4d40-86fe-85054a91017b","owner":"10165930","values":[{"key":"baseURL","value":"https://learningplatform.customer.com","type":"default","enabled":true},{"key":"client","value":"","type":"secret","enabled":true},{"key":"secret","value":"","type":"secret","enabled":true},{"key":"accessToken","value":"","type":"default","enabled":true},{"key":"bearerToken","value":"","type":"default","enabled":true},{"key":"userUsername","value":"","type":"default","enabled":true},{"key":"userPassword","value":"","type":"secret","enabled":true},{"key":"organisationId","value":"","type":"default","enabled":true},{"key":"userId","value":"","type":"default","enabled":true}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/45ac497761d8e41c22152b1ec4a213dd4aec90f39ed37b1995a5d7f8e8e8eb4e","favicon":"https://learningpool.com/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"Learning Platform Environment","value":"10165930-17fed4b1-d05f-4d40-86fe-85054a91017b"}],"canonicalUrl":"https://platform-apidocs.learningpool.com/view/metadata/2sBXcDFgZe"}