Developer docs
Your academy's data, on tap.
A clean REST API and webhooks over the data you already own — courses, students, enrolments, test results and payments. Build report dashboards, sync your CRM, or automate admissions follow-ups.
1. Authentication
Every Pro academy can request an API token from Dashboard → Settings → API. Tokens are scoped to your academy alone and carry full read access; treat them like passwords. Send the token on every request:
curl https://api.prepvidya.com/v1/courses \
-H "Authorization: Bearer pv_live_xxxxxxxxxxxx"2. Endpoints
REST, JSON in and out. List endpoints paginate with ?page and ?limit (max 100), and every response is scoped to your academy — there is no cross-tenant data, by design.
| Method | Endpoint | Returns |
|---|---|---|
| GET | /v1/courses | List published courses with pricing, cover image and enrollment counts. |
| GET | /v1/courses/{id} | Course detail: chapters, lesson list (titles only), batch schedules. |
| GET | /v1/students | Paginated student roster with signup source and last-active date. |
| GET | /v1/enrollments | Enrolments filtered by course or batch, with payment status. |
| GET | /v1/tests/{id}/results | Attempt-level results: scores, percentiles, section breakdowns. |
| GET | /v1/attendance | Live-class attendance and replay watch-time per student. |
| POST | /v1/enquiries | Push a lead (name, phone, interest) into your academy's enquiries pipeline. |
| GET | /v1/reports/fees | Collections ledger with instalment status and settlement references. |
3. Webhooks
Register an HTTPS endpoint in Dashboard → Settings → API and we'll POST signed events (HMAC-SHA256 in the X-PV-Signature header) as they happen. Failed deliveries retry with backoff for 24 hours.
student.created
A new learner registers on your academy.
enrollment.created
A student enrolls (free or paid) in a course or test series.
payment.succeeded
A fee instalment or one-time purchase completes.
test.completed
A student submits a test attempt (score + percentile included).
class.ended
A SuperLive class ends; replay URL becomes available.
certificate.issued
A completion certificate is generated (verify URL included).
Errors & limits
Standard HTTP codes: 401 bad token, 403 token lacks scope, 429 rate limited (600 requests/minute; honour Retry-After), 5xx our fault — retry with backoff. Webhook payloads are versioned; breaking changes ship as new event names with 6 months of overlap.
Request API access
API and webhooks are available on paid plans. Tell us what you're building — CRM sync, custom parent portals, scholarship benches — and we'll enable your token and review your integration.
Request access