{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"516fb233-1c1d-4ce8-93f3-a7952d6d4de0","name":"Zenslearn Public API","description":"# Zenslearn Public API\n\n**Version:** v1 | **Base URL:** `https://api.zenslearn.com/api/v1/public`\n\nProgrammatic access to your institute's LMS data for seamless integration with CRMs, ERPs, admissions systems, and custom applications.\n\n---\n\n## Quick Start\n\n**1.** Generate an API key from your LMS admin panel: **Settings → API Keys**\n\n**2.** Add the key to every request header:\n\n```\nX-API-Key: your_api_key_here\n\n ```\n\n**3.** Make your first call:\n\n``` bash\ncurl https://api.zenslearn.com/api/v1/public/students \\\n  -H \"X-API-Key: your_api_key_here\"\n\n ```\n\n---\n\n## Authentication\n\nAll endpoints require an API key via the `X-API-Key` header. Each key is:\n\n| Property | Description |\n| --- | --- |\n| **Institute-scoped** | Keys are bound to your institute — you can only access your own data |\n| **Scope-controlled** | Granular permissions: `read`, `write`, or resource-specific like `students:read` |\n| **Expirable** | Optional TTL for time-limited integrations |\n| **Revocable** | Instant revocation from the admin panel |\n| **Hashed at rest** | If lost, revoke and create a new one |\n\n## Rate Limits\n\n| Limit | Value |\n| --- | --- |\n| General | **1,000 requests/minute** per API key |\n| Student creation | **20 requests/minute** per API key |\n\n`429 Too Many Requests` responses include a `Retry-After` header (seconds).\n\n## ERP → LMS Fee Writes (Idempotency)\n\nThe **Fees & Payments** folder includes write endpoints so any ERP can push the fee lifecycle into the LMS: create plan, record payment, cancel plan, waive installment. These require the `fees:write` scope.\n\n**Record Payment requires an** **`Idempotency-Key`** **header** (e.g. your ERP's payment/doc id). Retries with the same key replay the original result; reuse with a different body returns `409`. ERP-originated writes are tagged so they are not echoed back out to your ERP webhooks/sync.\n\n## Response Format\n\n**Paginated lists:**\n\n``` json\n{\n  \"data\": [...],\n  \"total\": 250,\n  \"page\": 1,\n  \"per_page\": 20,\n  \"total_pages\": 13\n}\n\n ```\n\n**Single resource:** Returns the object directly (no wrapper).\n\n**Errors:**\n\n``` json\n{\n  \"detail\": \"Human-readable error message\"\n}\n\n ```\n\n## Pagination\n\nAll list endpoints accept these query parameters:\n\n| Parameter | Default | Description |\n| --- | --- | --- |\n| `page` | `1` | Page number (1-indexed) |\n| `per_page` | `20` | Items per page (max: 100) |\n\n## Error Codes\n\n| Code | Meaning |\n| --- | --- |\n| `400` | Validation error or business rule violation (e.g. missing Idempotency-Key) |\n| `401` | Missing, invalid, or expired API key |\n| `403` | Insufficient scope or institute suspended |\n| `404` | Resource not found (or belongs to another institute) |\n| `409` | Conflict (already paid/cancelled, or idempotency-key reuse with a different body) |\n| `422` | Unprocessable (e.g. overpayment — body includes `remaining_balance`) |\n| `429` | Rate limit exceeded |\n| `500` | Internal server error |\n\n## Scopes Reference\n\n| Scope | Access |\n| --- | --- |\n| `read` | All read endpoints |\n| `write` | All write endpoints |\n| `students:read` | List/get students only |\n| `students:write` | Create/update students |\n| `students:pii` | Include phone numbers in student responses |\n| `batches:read` | List/get batches |\n| `courses:read` | List/get courses |\n| `enrollments:read` / `enrollments:write` | Enrollment operations |\n| `certificates:read` / `certificates:write` | Certificate operations |\n| `classes:read` | Classes and attendance |\n| `announcements:read` / `announcements:write` | Announcement operations |\n| `jobs:read` | Job postings |\n| `fees:read` | Fee plans, installments, payments, per-student summary (read) |\n| `fees:write` | Create plan, record payment, cancel plan, waive installment |\n| `teachers:read` | Teachers |\n| `progress:read` | Lecture progress |\n| `recordings:read` | Class recordings |\n\n## Versioning\n\nURL-prefixed (`/api/v1/public`). Breaking changes ship under `/api/v2/\\\\\\\\\\*` with a minimum **6-month deprecation window**.\n\n## SDK & Language Support\n\nNo official SDK required. Works with any HTTP client: Python `httpx`/`requests`, Node `fetch`/`axios`, Go `net/http`, PHP `Guzzle`, C# `HttpClient`, etc.\n\n---\n\n**Need help?** Contact your Zenslearn account manager or email [<b>support@zenslearn.com</b>](https://mailto:support@zenslearn.com)","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":true,"owner":"51471734","team":12758682,"collectionId":"516fb233-1c1d-4ce8-93f3-a7952d6d4de0","publishedId":"2sBXwntCRo","public":true,"publicUrl":"https://docs.zenslearn.com","privateUrl":"https://go.postman.co/documentation/51471734-516fb233-1c1d-4ce8-93f3-a7952d6d4de0","customColor":{"top-bar":"1a1a2e","right-sidebar":"16213e","highlight":"0f3460"},"documentationLayout":"classic-single-column","customisation":{"metaTags":[{"name":"description","value":"Official API documentation for the Zenslearn LMS platform. Integrate student management, enrollments, courses, fees, certificates, and more into your existing systems."},{"name":"title","value":"Zenslearn Public API Documentation"}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/1bcc2dfd-f238-492d-ac5e-a4a4a3264fd4/aWNvbi1vbi1kYXJrLTUxMi5wbmc=","colors":{"top-bar":"1a1a2e","right-sidebar":"16213e","highlight":"0f3460"}},{"name":"light","logo":"https://content.pstmn.io/647b731f-ba19-48f7-8c75-3e60c375d283/aWNvbi1vbi13aGl0ZS01MTIucG5n","colors":{"top-bar":"1a1a2e","right-sidebar":"16213e","highlight":"0f3460"}}]}},"version":"8.11.6","publishDate":"2026-06-24T09:38:11.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"Zenslearn Public API Documentation","description":"Official API documentation for the Zenslearn LMS platform. Integrate student management, enrollments, courses, fees, certificates, and more into your existing systems."},"logos":{"logoLight":"https://content.pstmn.io/647b731f-ba19-48f7-8c75-3e60c375d283/aWNvbi1vbi13aGl0ZS01MTIucG5n","logoDark":"https://content.pstmn.io/1bcc2dfd-f238-492d-ac5e-a4a4a3264fd4/aWNvbi1vbi1kYXJrLTUxMi5wbmc="}},"statusCode":200},"environments":[],"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/61c2a87f922eefb0c5f262afd7ca0f1f6e8696c60f4d199318fa36cc6ad68523","favicon":"https://zenslearn.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"}],"canonicalUrl":"https://docs.zenslearn.com/view/metadata/2sBXwntCRo"}