Version: v1 | Base URL: https://api.zenslearn.com/api/v1/public
Programmatic access to your institute's LMS data for seamless integration with CRMs, ERPs, admissions systems, and custom applications.
\n1. Generate an API key from your LMS admin panel: Settings → API Keys
\n2. Add the key to every request header:
\nX-API-Key: your_api_key_here\n\n3. Make your first call:
\ncurl https://api.zenslearn.com/api/v1/public/students \\\n -H \"X-API-Key: your_api_key_here\"\n\nAll endpoints require an API key via the X-API-Key header. Each key is:
429 Too Many Requests responses include a Retry-After header (seconds).
The 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.
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.
Paginated lists:
\n{\n \"data\": [...],\n \"total\": 250,\n \"page\": 1,\n \"per_page\": 20,\n \"total_pages\": 13\n}\n\nSingle resource: Returns the object directly (no wrapper).
\nErrors:
\n{\n \"detail\": \"Human-readable error message\"\n}\n\nAll list endpoints accept these query parameters:
\nURL-prefixed (/api/v1/public). Breaking changes ship under /api/v2/\\\\\\\\\\* with a minimum 6-month deprecation window.
No official SDK required. Works with any HTTP client: Python httpx/requests, Node fetch/axios, Go net/http, PHP Guzzle, C# HttpClient, etc.
Need help? Contact your Zenslearn account manager or email support@zenslearn.com
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Zenslearn Public API","slug":"zenslearn-public-api"}],"owner":"51471734","collectionId":"516fb233-1c1d-4ce8-93f3-a7952d6d4de0","publishedId":"2sBXwntCRo","public":true,"customColor":{"top-bar":"1a1a2e","right-sidebar":"16213e","highlight":"0f3460"},"publishDate":"2026-06-24T09:38:11.000Z"},"item":[{"name":"Students","item":[{"name":"List Students","id":"03cdc625-4535-4032-97e2-833fc12fde4a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.zenslearn.com/api/v1/public/students?page=1&per_page=20","description":"Returns a paginated list of all students in your institute.
\nScope: students:read or read | Rate limit: 1,000/min
Search by name, email, or phone
\n","type":"text/plain"},"key":"search","value":""},{"disabled":true,"description":{"content":"Filter by status: active, inactive
\n","type":"text/plain"},"key":"status","value":""},{"description":{"content":"Page number (default: 1)
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"Items per page (default: 20, max: 100)
\n","type":"text/plain"},"key":"per_page","value":"20"}],"variable":[]}},"response":[{"id":"f2eb7f5c-60fa-46ef-a38d-350262db5121","name":"200 — Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.zenslearn.com/api/v1/public/students?page=1&per_page=20","host":["https://api.zenslearn.com/api/v1/public"],"path":["students"],"query":[{"key":"search","value":"","description":"Search by name, email, or phone","disabled":true},{"key":"status","value":"","description":"Filter by status: active, inactive","disabled":true},{"key":"page","value":"1","description":"Page number (default: 1)"},{"key":"per_page","value":"20","description":"Items per page (default: 20, max: 100)"}]},"description":"Returns a paginated list of all students in your institute.\n\n**Scope:** `students:read` or `read` | **Rate limit:** 1,000/min\n\n### Query Parameters\n| Parameter | Type | Default | Description |\n|-----------|------|---------|-------------|\n| `search` | string | — | Filter by name, email, or phone |\n| `status` | string | — | Filter: `active` or `inactive` |\n| `page` | integer | `1` | Page number |\n| `per_page` | integer | `20` | Items per page (max: 100) |\n\n### Response Fields\n| Field | Type | Description |\n|-------|------|-------------|\n| `id` | uuid | Student unique identifier |\n| `email` | string | Student email address |\n| `name` | string | Full name |\n| `phone` | string/null | Phone number (requires `students:pii` scope) |\n| `status` | string | `active` or `inactive` |\n| `created_at` | datetime | ISO 8601 timestamp |"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"0360ad10-9512-4937-9efd-cb3303921fc8\",\n \"email\": \"ali@example.com\",\n \"name\": \"Ali Ahmed\",\n \"phone\": null,\n \"status\": \"active\",\n \"created_at\": \"2026-03-07T12:05:49.095153Z\"\n }\n ],\n \"total\": 1,\n \"page\": 1,\n \"per_page\": 20,\n \"total_pages\": 1\n}"}],"_postman_id":"03cdc625-4535-4032-97e2-833fc12fde4a"},{"name":"Get Student","id":"64a9ce46-c9bb-44b1-9d26-de0b03fff94b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.zenslearn.com/api/v1/public/students/","description":"Retrieve a single student by their UUID.
\nScope: students:read or read | Rate limit: 1,000/min
Create a new student in your institute. Automatically checks against your plan's student quota.
\nScope: students:write or write | Rate limit: 20/min
user.created webhook eventUpdate an existing student's profile. Only name and phone can be modified.
Scope: students:write or write | Rate limit: 1,000/min
At least one field must be provided.
\nManage student records in your institute.
\nAvailable scopes:
\n\n\n","_postman_id":"341e2436-439b-4d5f-9f1d-170dcbb1f55d","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"your_api_key_here"}]},"isInherited":true,"source":{"_postman_id":"516fb233-1c1d-4ce8-93f3-a7952d6d4de0","id":"516fb233-1c1d-4ce8-93f3-a7952d6d4de0","name":"Zenslearn Public API","type":"collection"}}},{"name":"Batches","item":[{"name":"List Batches","id":"527484ac-0081-4196-b7a1-c4e5cbed773c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.zenslearn.com/api/v1/public/batches?page=1&per_page=20","description":"Note: Phone numbers are redacted (returned as
\nnull) unless the API key has thestudents:piiscope. This protects student privacy by default.
Returns all batches for your institute with student/course counts and computed status.
\nScope: batches:read or read | Rate limit: 1,000/min
Page number
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"Items per page (max 100)
\n","type":"text/plain"},"key":"per_page","value":"20"}],"variable":[]}},"response":[{"id":"5e749084-3111-4add-80f7-ce042c28b085","name":"200 — Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.zenslearn.com/api/v1/public/batches?page=1&per_page=20","host":["https://api.zenslearn.com/api/v1/public"],"path":["batches"],"query":[{"key":"page","value":"1","description":"Page number"},{"key":"per_page","value":"20","description":"Items per page (max 100)"}]},"description":"Returns all batches for your institute with student/course counts and computed status.\n\n**Scope:** `batches:read` or `read` | **Rate limit:** 1,000/min\n\n### Response Fields\n| Field | Type | Description |\n|-------|------|-------------|\n| `id` | uuid | Batch unique identifier |\n| `name` | string | Batch display name |\n| `start_date` | date | Batch start date |\n| `end_date` | date | Batch end date |\n| `teacher_name` | string | Assigned teacher |\n| `student_count` | integer | Number of enrolled students |\n| `course_count` | integer | Number of linked courses |\n| `status` | string | Computed: `upcoming`, `active`, or `completed` |\n| `created_at` | datetime | ISO 8601 timestamp |"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"b1234567-...\",\n \"name\": \"Batch 1 - January 2026\",\n \"start_date\": \"2026-01-15\",\n \"end_date\": \"2026-04-15\",\n \"teacher_name\": \"Ahmed Khan\",\n \"student_count\": 28,\n \"course_count\": 2,\n \"status\": \"active\",\n \"created_at\": \"2026-01-01T00:00:00Z\"\n }\n ],\n \"total\": 1,\n \"page\": 1,\n \"per_page\": 20,\n \"total_pages\": 1\n}"}],"_postman_id":"527484ac-0081-4196-b7a1-c4e5cbed773c"},{"name":"Get Batch","id":"c62a26b4-a0a8-4225-8f38-8c4d60d03e77","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.zenslearn.com/api/v1/public/batches/","description":"Retrieve a single batch by ID with student count, course count, and computed status.
\nScope: batches:read or read | Rate limit: 1,000/min
View batch information including student counts, course assignments, and computed status.
\nScope required: batches:read or read
Batch status is computed automatically from dates:
\nupcoming — start date is in the futureactive — current date is between start and endcompleted — end date has passedReturns all courses in your institute.
\nScope: courses:read or read | Rate limit: 1,000/min
Retrieve a single course with its curriculum modules.
\nScope: courses:read or read | Rate limit: 1,000/min
Returns the course object with an additional modules array containing each curriculum module's id, title, and order.
View courses and their curriculum modules.
\nScope required: courses:read or read
The detail endpoint (GET /courses/{id}) includes the course's curriculum modules with their ordering.
List all student-batch enrollments.
\nScope: enrollments:read or read | Rate limit: 1,000/min
Filter by batch
\n","type":"text/plain"},"key":"batch_id","value":""},{"disabled":true,"description":{"content":"Filter by student
\n","type":"text/plain"},"key":"student_id","value":""},{"key":"page","value":"1"},{"key":"per_page","value":"20"}],"variable":[]}},"response":[{"id":"a4c72844-0fb2-472e-a98d-88b5376a834d","name":"200 — Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.zenslearn.com/api/v1/public/enrollments?page=1&per_page=20","host":["https://api.zenslearn.com/api/v1/public"],"path":["enrollments"],"query":[{"key":"batch_id","value":"","description":"Filter by batch","disabled":true},{"key":"student_id","value":"","description":"Filter by student","disabled":true},{"key":"page","value":"1"},{"key":"per_page","value":"20"}]},"description":"List all student-batch enrollments.\n\n**Scope:** `enrollments:read` or `read` | **Rate limit:** 1,000/min\n\n### Query Parameters\n| Parameter | Type | Default | Description |\n|-----------|------|---------|-------------|\n| `batch_id` | uuid | — | Filter by batch |\n| `student_id` | uuid | — | Filter by student |\n| `page` | integer | `1` | Page number |\n| `per_page` | integer | `20` | Items per page (max: 100) |\n\n### Response Fields\n| Field | Type | Description |\n|-------|------|-------------|\n| `id` | uuid | Enrollment unique identifier |\n| `student_id` | uuid | Student ID |\n| `student_name` | string | Student full name |\n| `student_email` | string | Student email |\n| `batch_id` | uuid | Batch ID |\n| `batch_name` | string | Batch name |\n| `enrolled_at` | datetime | Enrollment timestamp |"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"e1234...\",\n \"student_id\": \"s1234...\",\n \"student_name\": \"Ali Ahmed\",\n \"student_email\": \"ali@example.com\",\n \"batch_id\": \"b1234...\",\n \"batch_name\": \"Batch 1\",\n \"enrolled_at\": \"2026-01-15T00:00:00Z\"\n }\n ],\n \"total\": 1,\n \"page\": 1,\n \"per_page\": 20,\n \"total_pages\": 1\n}"}],"_postman_id":"7906de5f-b4b5-4d21-af70-07a2a06fcfd9"},{"name":"Enroll Student","id":"2fd5e570-bcf7-4b87-843c-b7368e896ddb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"student_id\": \"\",\n \"batch_id\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.zenslearn.com/api/v1/public/enrollments","description":"Enroll a student in a batch. Both the student and batch must belong to your institute.
\nScope: enrollments:write or write | Rate limit: 1,000/min
enrollment.created webhook eventRemove a student from a batch.
\nScope: enrollments:write or write | Rate limit: 1,000/min
enrollment.removed webhook eventManage student-batch enrollments. Enroll students into batches or remove them.
\nAvailable scopes:
\n","_postman_id":"c59d1c48-6b29-4c17-a64f-a8cb37f9e793","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"your_api_key_here"}]},"isInherited":true,"source":{"_postman_id":"516fb233-1c1d-4ce8-93f3-a7952d6d4de0","id":"516fb233-1c1d-4ce8-93f3-a7952d6d4de0","name":"Zenslearn Public API","type":"collection"}}},{"name":"Certificates","item":[{"name":"List Certificates","id":"19474508-0261-4f19-a063-f7dca5cac40a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.zenslearn.com/api/v1/public/certificates?page=1&per_page=20","description":"List all issued certificates for your institute.
\nScope: certificates:read or read | Rate limit: 1,000/min
Filter by batch
\n","type":"text/plain"},"key":"batch_id","value":""},{"disabled":true,"description":{"content":"Filter by course
\n","type":"text/plain"},"key":"course_id","value":""},{"disabled":true,"description":{"content":"Filter by status
\n","type":"text/plain"},"key":"status","value":""},{"key":"page","value":"1"},{"key":"per_page","value":"20"}],"variable":[]}},"response":[{"id":"84117e34-fe25-4bc0-8c68-5a084eeb0eff","name":"200 — Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.zenslearn.com/api/v1/public/certificates?page=1&per_page=20","host":["https://api.zenslearn.com/api/v1/public"],"path":["certificates"],"query":[{"key":"batch_id","value":"","description":"Filter by batch","disabled":true},{"key":"course_id","value":"","description":"Filter by course","disabled":true},{"key":"status","value":"","description":"Filter by status","disabled":true},{"key":"page","value":"1"},{"key":"per_page","value":"20"}]},"description":"List all issued certificates for your institute.\n\n**Scope:** `certificates:read` or `read` | **Rate limit:** 1,000/min\n\n### Query Parameters\n| Parameter | Type | Default | Description |\n|-----------|------|---------|-------------|\n| `batch_id` | uuid | — | Filter by batch |\n| `course_id` | uuid | — | Filter by course |\n| `status` | string | — | Filter by certificate status |\n| `page` | integer | `1` | Page number |\n| `per_page` | integer | `20` | Items per page (max: 100) |\n\n### Response Fields\n| Field | Type | Description |\n|-------|------|-------------|\n| `id` | uuid | Certificate unique identifier |\n| `student_id` | uuid | Student ID |\n| `student_name` | string | Student full name |\n| `certificate_id` | string | Human-readable certificate ID |\n| `verification_code` | string | Public verification code |\n| `status` | string | Certificate status |\n| `completion_percentage` | integer | Course completion % |\n| `issued_at` | datetime | Issuance timestamp |"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"cert-1234...\",\n \"student_id\": \"s1234...\",\n \"student_name\": \"Ali Ahmed\",\n \"certificate_id\": \"CERT-2026-001\",\n \"verification_code\": \"ABC123XYZ\",\n \"status\": \"approved\",\n \"completion_percentage\": 100,\n \"issued_at\": \"2026-04-15T00:00:00Z\"\n }\n ],\n \"total\": 1,\n \"page\": 1,\n \"per_page\": 20,\n \"total_pages\": 1\n}"}],"_postman_id":"19474508-0261-4f19-a063-f7dca5cac40a"},{"name":"Approve Certificate","id":"ceddb86f-8827-4020-96eb-b719b9e6c2ce","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://api.zenslearn.com/api/v1/public/certificates//approve","description":"Approve a pending certificate for issuance.
\nScope: certificates:write or write | Rate limit: 1,000/min
certificate.approved webhook eventRevoke a previously issued certificate.
\nScope: certificates:write or write | Rate limit: 1,000/min
certificate.revoked webhook eventView, approve, and revoke student certificates.
\nAvailable scopes:
\nEach certificate includes a unique verification_code for public verification.
List all scheduled and completed Zoom classes.
\nScope: classes:read or read | Rate limit: 1,000/min
Filter by batch
\n","type":"text/plain"},"key":"batch_id","value":""},{"disabled":true,"description":{"content":"Filter by class status
\n","type":"text/plain"},"key":"status","value":""},{"key":"page","value":"1"},{"key":"per_page","value":"20"}],"variable":[]}},"response":[{"id":"7e2fb38e-1cc9-4241-9473-8e39e4b146ea","name":"200 — Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.zenslearn.com/api/v1/public/classes?page=1&per_page=20","host":["https://api.zenslearn.com/api/v1/public"],"path":["classes"],"query":[{"key":"batch_id","value":"","description":"Filter by batch","disabled":true},{"key":"status","value":"","description":"Filter by class status","disabled":true},{"key":"page","value":"1"},{"key":"per_page","value":"20"}]},"description":"List all scheduled and completed Zoom classes.\n\n**Scope:** `classes:read` or `read` | **Rate limit:** 1,000/min\n\n### Query Parameters\n| Parameter | Type | Default | Description |\n|-----------|------|---------|-------------|\n| `batch_id` | uuid | — | Filter by batch |\n| `status` | string | — | Filter by class status |\n| `page` | integer | `1` | Page number |\n| `per_page` | integer | `20` | Items per page (max: 100) |\n\n### Response Fields\n| Field | Type | Description |\n|-------|------|-------------|\n| `id` | uuid | Class unique identifier |\n| `batch_id` | uuid | Associated batch |\n| `title` | string | Class title |\n| `scheduled_date` | date | Scheduled date |\n| `scheduled_time` | datetime | ISO 8601 start time |\n| `duration` | integer | Duration in minutes |\n| `status` | string | Class status |"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"cl-1234...\",\n \"batch_id\": \"b1234...\",\n \"title\": \"JavaScript Fundamentals\",\n \"scheduled_date\": \"2026-03-20\",\n \"scheduled_time\": \"2026-03-20T10:00:00Z\",\n \"duration\": 60,\n \"status\": \"completed\"\n }\n ],\n \"total\": 1,\n \"page\": 1,\n \"per_page\": 20,\n \"total_pages\": 1\n}"}],"_postman_id":"75a5f111-e05f-44be-af04-0e406ffb654f"},{"name":"Get Class Attendance","id":"d606d5c3-4cdc-4612-8765-9c72fc56f347","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.zenslearn.com/api/v1/public/classes//attendance","description":"Get attendance records for a specific class.
\nScope: classes:read or read | Rate limit: 1,000/min
Returns an array (not paginated) of attendance records:
\nView scheduled Zoom classes and their attendance records.
\nScope required: classes:read or read
Attendance is tracked automatically via Zoom webhook integration. Each attendance record includes the student's actual join duration.
\n","_postman_id":"ac16f069-4a71-4cdc-a595-61de823b0911","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"your_api_key_here"}]},"isInherited":true,"source":{"_postman_id":"516fb233-1c1d-4ce8-93f3-a7952d6d4de0","id":"516fb233-1c1d-4ce8-93f3-a7952d6d4de0","name":"Zenslearn Public API","type":"collection"}}},{"name":"Announcements","item":[{"name":"List Announcements","id":"8df808d1-997b-460f-b54d-4e539a9ea8ce","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.zenslearn.com/api/v1/public/announcements?page=1&per_page=20","description":"List all announcements for your institute.
\nScope: announcements:read or read | Rate limit: 1,000/min
Create a new announcement visible to students.
\nScope: announcements:write or write | Rate limit: 1,000/min
View and create announcements for students.
\nAvailable scopes:
\nAnnouncements can be scoped to all students, a specific batch, or a specific course.
List all job postings published by your institute.
\nScope: jobs:read or read | Rate limit: 1,000/min
View job postings published by your institute.
\nScope required: jobs:read or read
List all fee plans for your institute.
\nScope: fees:read or read | Rate limit: 1,000/min
Filter by student
\n","type":"text/plain"},"key":"student_id","value":""},{"disabled":true,"description":{"content":"Filter by batch
\n","type":"text/plain"},"key":"batch_id","value":""},{"disabled":true,"description":{"content":"Filter by status
\n","type":"text/plain"},"key":"status","value":""},{"key":"page","value":"1"},{"key":"per_page","value":"20"}],"variable":[]}},"response":[{"id":"97f4440d-040f-488a-8009-36ce154b7b98","name":"200 — Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.zenslearn.com/api/v1/public/fees?page=1&per_page=20","host":["https://api.zenslearn.com/api/v1/public"],"path":["fees"],"query":[{"key":"student_id","value":"","description":"Filter by student","disabled":true},{"key":"batch_id","value":"","description":"Filter by batch","disabled":true},{"key":"status","value":"","description":"Filter by status","disabled":true},{"key":"page","value":"1"},{"key":"per_page","value":"20"}]},"description":"List all fee plans for your institute.\n\n**Scope:** `fees:read` or `read` | **Rate limit:** 1,000/min\n\n### Query Parameters\n| Parameter | Type | Default | Description |\n|-----------|------|---------|-------------|\n| `student_id` | uuid | — | Filter by student |\n| `batch_id` | uuid | — | Filter by batch |\n| `status` | string | — | Filter by fee plan status |\n| `page` | integer | `1` | Page number |\n| `per_page` | integer | `20` | Items per page (max: 100) |\n\n### Response Fields\n| Field | Type | Description |\n|-------|------|-------------|\n| `id` | uuid | Fee plan unique identifier |\n| `student_id` | uuid | Student ID |\n| `student_name` | string | Student full name |\n| `batch_id` | uuid | Batch ID |\n| `batch_name` | string | Batch name |\n| `plan_type` | string | Fee plan type |\n| `total_amount` | number | Total fee amount |\n| `discount_type` | string | Discount type (if any) |\n| `discount_value` | number | Discount value |\n| `final_amount` | number | Amount after discount |\n| `currency` | string | Currency code (e.g. `PKR`) |\n| `status` | string | Plan status |\n| `created_at` | datetime | ISO 8601 timestamp |"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"fp-1234...\",\n \"student_id\": \"s1234...\",\n \"student_name\": \"Ali Ahmed\",\n \"batch_id\": \"b1234...\",\n \"batch_name\": \"Batch 1\",\n \"plan_type\": \"installment\",\n \"total_amount\": 50000,\n \"discount_type\": \"percentage\",\n \"discount_value\": 10,\n \"final_amount\": 45000,\n \"currency\": \"PKR\",\n \"status\": \"active\",\n \"created_at\": \"2026-01-15T00:00:00Z\"\n }\n ],\n \"total\": 1,\n \"page\": 1,\n \"per_page\": 20,\n \"total_pages\": 1\n}"}],"_postman_id":"8370b551-aebb-4d2e-9b6f-7b4d6cd746f2"},{"name":"Get Fee Plan (with Installments)","id":"3719ab9e-5149-448d-84af-1ceca2072930","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.zenslearn.com/api/v1/public/fees/","description":"Retrieve a fee plan with its full installment breakdown.
\nScope: fees:read or read | Rate limit: 1,000/min
Returns the fee plan with an installments array. Each installment contains:
List all payments recorded against a specific fee plan.
\nScope: fees:read or read | Rate limit: 1,000/min
List all payments across all fee plans in your institute.
\nScope: fees:read or read | Rate limit: 1,000/min
Filter by fee plan
\n","type":"text/plain"},"key":"fee_plan_id","value":""},{"key":"page","value":"1"},{"key":"per_page","value":"20"}],"variable":[]}},"response":[],"_postman_id":"a97dadba-7bc6-4ace-ba9e-1c87088f98b5"},{"name":"Create Fee Plan","id":"3990984a-1776-871a-0d6d-6e2ab4146b0d","request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"batch_id\": \"\",\n \"plan_type\": \"monthly\",\n \"total_amount\": 120000,\n \"monthly_installments\": 12,\n \"first_due_date\": \"2026-07-01\",\n \"grace_period_hours\": 72\n}","options":{"raw":{"language":"json"}}},"url":"https://api.zenslearn.com/api/v1/public/students//fees","description":"Create a fee plan for a student.
\nScope: fees:write or write | Rate limit: 1,000/min
REQUIRED. Unique per logical payment (e.g. the ERP payment/doc id). Replays return the same result; reuse with a different body returns 409.
\n","value":""}],"body":{"mode":"raw","raw":"{\n \"amount\": 10000,\n \"payment_date\": \"2026-07-01T10:00:00Z\",\n \"payment_method\": \"bank_transfer\",\n \"reference_number\": \"TXN-1\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.zenslearn.com/api/v1/public/fees//payments","description":"Record a payment against a plan/installment. Scope: fees:write. Idempotency-Key header is REQUIRED (400 if missing). payment_method: bank_transfer | jazzcash | easypaisa | cheque | cash | online. Auto-assigns a receipt number, updates installment/plan state, clears the 402 fee-lock. Conflicts: 409 if the installment is already fully paid; 422 if amount exceeds the remaining balance (body includes remaining_balance).
Finance verifies (or rejects) a recorded payment — step 2 of the ERP→LMS record→verify flow. Scope: fees:verify (NOT satisfied by the generic write super-scope — separation of duties). Rate limit: 60/min.
decision: verified | rejected. On verified, a student auto-deactivated for overdue fees is reactivated. Idempotent: re-sending the same decision is a no-op; flipping a settled decision (verified↔rejected) returns 409.
Body: { decision (required), note?, admissions_officer_id? }
Returns: { id, fee_plan_id, fee_installment_id, amount, status, verification_status, verified_at, receipt_number, student_id, student_status, student_reactivated }
Errors: 403 missing fees:verify scope · 404 payment not found (or other institute) · 409 already settled with the opposite decision · 422 invalid decision/admissions_officer_id.
Cancel a fee plan (status → cancelled). Scope: fees:write. Optional admissions_officer_id. 409 if the plan is already cancelled.
Waive a single installment by its sequence number (path: .../installments/{sequence}/waive; example uses 1). Scope: fees:write. Sets the installment to waived and completes the plan if every installment is now paid or waived. 409 if the installment is already paid or waived.
Per-student fee summary. Scope: fees:read. Returns aggregate totals (total_billed, total_paid, total_remaining, overdue_amount, next_due_date, is_overdue) plus each plan with rollups + installments. One call to see all of a student's dues/remaining.
Optional. Set a unique value (e.g. your ERP doc id) so retries replay instead of double-creating.
\n","value":""}],"body":{"mode":"raw","raw":"{\n \"batch_id\": \"\",\n \"plan_type\": \"installment\",\n \"total_amount\": 60000,\n \"currency\": \"PKR\",\n \"installments\": [\n { \"sequence\": 1, \"amount_due\": 30000, \"due_date\": \"2026-07-01\", \"label\": \"Admission\" },\n { \"sequence\": 2, \"amount_due\": 15000, \"due_date\": \"2026-08-01\", \"label\": \"Mid-term\" },\n { \"sequence\": 3, \"amount_due\": 15000, \"due_date\": \"2026-09-01\", \"label\": \"Final\" }\n ],\n \"admissions_officer_id\": \"{{officer_id}}\",\n \"grace_period_hours\": 72\n}","options":{"raw":{"language":"json"}}},"url":"https://api.zenslearn.com/api/v1/public/students//fees","description":"Create a fee plan with a custom installment schedule for an existing student in a batch. Scope: fees:write.
Rules for custom installments:
\nplan_type must be installment (this triggers the custom-schedule branch; one-time and monthly ignore the installments array and auto-generate).installments is required for this plan type — omitting it returns 422 \"Installment plan requires an installments schedule\".amount_due must equal final_amount (= total_amount after any discount). Mismatch → 422 \"Installment amounts sum to X but final amount is Y\".total_amount.discount_type = percent/flat, discount_value) → compute the discounted amount first, then make installments sum to that.sequence (≥1), amount_due (≥0, integer / whole rupees), due_date (YYYY-MM-DD), label (optional).In the example: 30000 + 15000 + 15000 = 60000 = total_amount. ✅
Optional: admissions_officer_id to credit a specific officer (omit to record the hidden per-institute system user); access_days or access_end_date (mutually exclusive) to set the enrollment's access window; notes (≤1000 chars); grace_period_hours (integer, 0–8760, default 72) to set the fee-overdue grace window in HOURS from plan creation — while inside it the student keeps full content access despite an unpaid installment and the overdue-suspension cron skips the plan.
Returns 201 + the plan with rollups (amount_paid, balance_due, next_due_date, is_overdue) and the echoed installments. 404 if student/batch/officer not found; 409 if the student is already enrolled in that batch.
Read fee plans, installments, payments, and per-student summaries — and write the fee lifecycle from any ERP.
\nRead (fees:read or read): list fee plans, plan detail with installments, payments, and GET /students/{id}/fees for a per-student summary (total billed/paid/remaining/overdue + per-plan rollups).
Write (fees:write or write): create plan, record payment, cancel plan, waive installment. Vendor-neutral — works for Frappe/ERPNext, Zoho, Odoo, or custom systems.
Record Payment requires an Idempotency-Key header (e.g. the ERP payment/doc id). Retries replay the original result; key reuse with a different body → 409; overpayment → 422 with remaining_balance; already paid/cancelled → 409. ERP-originated writes are tagged so they are not echoed back out to your ERP webhooks/sync.
List all teachers in your institute.
\nScope: teachers:read or read | Rate limit: 1,000/min
Retrieve a single teacher by ID.
\nScope: teachers:read or read | Rate limit: 1,000/min
View teacher profiles and their specializations.
\nScope required: teachers:read or read
List student lecture progress records.
\nScope: progress:read or read | Rate limit: 1,000/min
Filter by student
\n","type":"text/plain"},"key":"student_id","value":""},{"disabled":true,"description":{"content":"Filter by lecture
\n","type":"text/plain"},"key":"lecture_id","value":""},{"key":"page","value":"1"},{"key":"per_page","value":"20"}],"variable":[]}},"response":[{"id":"6d5dd73c-ec86-4127-8d31-07bc0f8c3eb5","name":"200 — Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.zenslearn.com/api/v1/public/progress?page=1&per_page=20","host":["https://api.zenslearn.com/api/v1/public"],"path":["progress"],"query":[{"key":"student_id","value":"","description":"Filter by student","disabled":true},{"key":"lecture_id","value":"","description":"Filter by lecture","disabled":true},{"key":"page","value":"1"},{"key":"per_page","value":"20"}]},"description":"List student lecture progress records.\n\n**Scope:** `progress:read` or `read` | **Rate limit:** 1,000/min\n\n### Query Parameters\n| Parameter | Type | Default | Description |\n|-----------|------|---------|-------------|\n| `student_id` | uuid | — | Filter by student |\n| `lecture_id` | uuid | — | Filter by lecture |\n| `page` | integer | `1` | Page number |\n| `per_page` | integer | `20` | Items per page (max: 100) |\n\n### Response Fields\n| Field | Type | Description |\n|-------|------|-------------|\n| `student_id` | uuid | Student ID |\n| `student_name` | string | Student full name |\n| `lecture_id` | uuid | Lecture ID |\n| `watch_percentage` | integer | Percentage watched (0-100) |\n| `status` | string | `not_started`, `in_progress`, or `completed` |\n| `updated_at` | datetime | Last progress update |"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"student_id\": \"s1234...\",\n \"student_name\": \"Ali Ahmed\",\n \"lecture_id\": \"l1234...\",\n \"watch_percentage\": 85,\n \"status\": \"in_progress\",\n \"updated_at\": \"2026-03-20T14:30:00Z\"\n }\n ],\n \"total\": 1,\n \"page\": 1,\n \"per_page\": 20,\n \"total_pages\": 1\n}"}],"_postman_id":"0291a432-dbba-4c1a-88ea-2fc85ca15220"}],"id":"ed3b5016-fa90-4e0a-9c77-42ae3411248b","description":"Track student lecture viewing progress.
\nScope required: progress:read or read
Progress includes watch percentage and completion status for each student-lecture pair.
\n","_postman_id":"ed3b5016-fa90-4e0a-9c77-42ae3411248b","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"your_api_key_here"}]},"isInherited":true,"source":{"_postman_id":"516fb233-1c1d-4ce8-93f3-a7952d6d4de0","id":"516fb233-1c1d-4ce8-93f3-a7952d6d4de0","name":"Zenslearn Public API","type":"collection"}}},{"name":"Recordings","item":[{"name":"List Recordings","id":"11cbf739-5249-4c69-bc7b-2267c95503ae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.zenslearn.com/api/v1/public/recordings?page=1&per_page=20","description":"List all class recordings.
\nScope: recordings:read or read | Rate limit: 1,000/min
Filter by class
\n","type":"text/plain"},"key":"class_id","value":""},{"key":"page","value":"1"},{"key":"per_page","value":"20"}],"variable":[]}},"response":[{"id":"330dcf90-21a7-4689-9916-10d504a8aaaa","name":"200 — Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.zenslearn.com/api/v1/public/recordings?page=1&per_page=20","host":["https://api.zenslearn.com/api/v1/public"],"path":["recordings"],"query":[{"key":"class_id","value":"","description":"Filter by class","disabled":true},{"key":"page","value":"1"},{"key":"per_page","value":"20"}]},"description":"List all class recordings.\n\n**Scope:** `recordings:read` or `read` | **Rate limit:** 1,000/min\n\n### Query Parameters\n| Parameter | Type | Default | Description |\n|-----------|------|---------|-------------|\n| `class_id` | uuid | — | Filter by class |\n| `page` | integer | `1` | Page number |\n| `per_page` | integer | `20` | Items per page (max: 100) |\n\n### Response Fields\n| Field | Type | Description |\n|-------|------|-------------|\n| `id` | uuid | Recording unique identifier |\n| `class_id` | uuid | Associated class |\n| `class_title` | string | Class title |\n| `duration` | integer | Duration in seconds |\n| `status` | string | Recording status |\n| `created_at` | datetime | ISO 8601 timestamp |"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"rec-1234...\",\n \"class_id\": \"cl-1234...\",\n \"class_title\": \"JavaScript Fundamentals\",\n \"duration\": 3600,\n \"status\": \"available\",\n \"created_at\": \"2026-03-20T11:00:00Z\"\n }\n ],\n \"total\": 1,\n \"page\": 1,\n \"per_page\": 20,\n \"total_pages\": 1\n}"}],"_postman_id":"11cbf739-5249-4c69-bc7b-2267c95503ae"},{"name":"Get Recording","id":"6c345941-4140-4c03-8237-655d65ae60ec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.zenslearn.com/api/v1/public/recordings/","description":"Retrieve a single recording by ID.
\nScope: recordings:read or read | Rate limit: 1,000/min
View class recording metadata.
\nScope required: recordings:read or read
Recordings are automatically captured from Zoom classes.
\n","_postman_id":"12b11b1d-b070-4d2a-8fb4-c6d15b7fa2f7","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"your_api_key_here"}]},"isInherited":true,"source":{"_postman_id":"516fb233-1c1d-4ce8-93f3-a7952d6d4de0","id":"516fb233-1c1d-4ce8-93f3-a7952d6d4de0","name":"Zenslearn Public API","type":"collection"}}},{"name":"Enrollment & Access","item":[{"name":"Enroll Student","id":"4fa7be0b-af2e-dd35-7775-beef4cf873fd","request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"student_id\": \"\",\n \"batch_id\": \"\",\n \"access_days\": 365\n}","options":{"raw":{"language":"json"}}},"url":"https://api.zenslearn.com/api/v1/public/enrollments","description":"Enroll a student in a batch with an optional access window. Scope: enrollments:write. Provide access_days (1–3650) or access_end_date (YYYY-MM-DD) — not both (422). Omit both → access inherits the batch end_date. Optional admissions_officer_id to attribute the action. 409 if already enrolled in this batch; 404 if student/batch not found.
Enroll many students into one batch. Scope: enrollments:write. student_ids max 500. Optional access_days/access_end_date (mutually exclusive) apply to all. Returns 200 { enrolled: [ids], errors: [{student_id, error}], count } — partial success (already-enrolled rows surface in errors, not as failures).
Pause a student's access to ONE batch without removing them (reversible). Scope: enrollments:write. Sets the enrollment is_active=false → student gets 403 on that batch's gated content until reactivated. 404 if no such enrollment.
Resume a student's access to one batch (reverses Deactivate). Scope: enrollments:write. Sets is_active=true. 404 if no such enrollment.
Suspend the whole student account across ALL batches and revoke their sessions. Scope: students:write. Reversible via Reactivate. 404 if student not found in this institute.
Reactivate a suspended student account (reverses Suspend). Scope: students:write. 404 if student not found.