For developers
API
Read and change your institute's people, courses, classes, fees and more from your own systems.
Address and keys
The API lives at your institute's address, under /api:
https://learn.yourschool.in/api/v1/coursesMake a key in Settings → Developers and send it in the Authorization header:
curl https://learn.yourschool.in/api/v1/members?roles=learner \
-H "Authorization: Bearer pdk_…"- A key acts as the staff member who made it, and stops working if they stop being staff.
- Some things need a person signed in, never a key: adding or changing owners and admins, connected services, your own address, your Paadam plan, your data, and API keys themselves.
- Read-only keys can only use
GET. - Each key can make 600 requests a minute.
- Keys are shown once. Revoke one in Settings and it stops at once.
Errors
Errors are JSON with an HTTP status to match:
{ "error": { "code": "validation_failed", "message": "Enter a valid phone number",
"details": { "fields": [{ "path": "phone", "message": "Enter a valid phone number" }] } } }The OpenAPI description
The full machine-readable description is at /api/v1/openapi.json on your address: import it into Postman, Insomnia or a code generator. Every endpoint is listed below.
People
get/v1/membersList people
Learners, parents, tutors and staff, filtered by role or searched by name, phone or email.
Query
roles | string |
q | string |
page | integer |
pageSize | integer |
Answer
| Field | Type |
|---|---|
itemsrequired | list of object |
totalrequired | integer |
pagerequired | integer |
pageSizerequired | integer |
countsrequired | object |
post/v1/membersAdd a person
Adds someone with one role. Someone already here with the same phone or email (and name) gets the role added instead of a duplicate.
Body
| Field | Type |
|---|---|
namerequired | string |
email | string |
phone | string |
rolerequired | one of: "owner", "admin", "tutor", "learner", "parent" |
password | string |
Answer
| Field | Type |
|---|---|
idrequired | string (uuid) |
namerequired | string |
emailrequired | string or null |
phonerequired | string or null |
rolesrequired | list of one of: "owner", "admin", "tutor", "learner", "parent" |
statusrequired | one of: "active", "suspended" |
createdAtrequired | string |
lastLoginAtrequired | string or null |
get/v1/members/{id}One person
Answer
| Field | Type |
|---|---|
idrequired | string (uuid) |
namerequired | string |
emailrequired | string or null |
phonerequired | string or null |
rolesrequired | list of one of: "owner", "admin", "tutor", "learner", "parent" |
statusrequired | one of: "active", "suspended" |
createdAtrequired | string |
lastLoginAtrequired | string or null |
tagsrequired | list of string |
profilerequired | object |
languagerequired | string or null |
parentsrequired | list of object |
childrenrequired | list of object |
learningrequired | list of object |
teachingrequired | list of object |
blockedFromPostingrequired | boolean |
patch/v1/members/{id}Change a person's details
Body
| Field | Type |
|---|---|
name | string |
email | string or null |
phone | string or null |
tags | list of string |
profile | object |
language | one of: "en", "ml" or null |
status | one of: "active", "suspended" |
Answer
| Field | Type |
|---|---|
idrequired | string (uuid) |
namerequired | string |
emailrequired | string or null |
phonerequired | string or null |
rolesrequired | list of one of: "owner", "admin", "tutor", "learner", "parent" |
statusrequired | one of: "active", "suspended" |
createdAtrequired | string |
lastLoginAtrequired | string or null |
tagsrequired | list of string |
profilerequired | object |
languagerequired | string or null |
parentsrequired | list of object |
childrenrequired | list of object |
learningrequired | list of object |
teachingrequired | list of object |
blockedFromPostingrequired | boolean |
post/v1/members/importAdd many people at once
Up to a few thousand rows; set dryRun to check them first. Can put learners straight into a course.
Body
| Field | Type |
|---|---|
rowsrequired | list of object |
courseId | string (uuid) |
dryRun | boolean |
Answer
| Field | Type |
|---|---|
createdrequired | integer |
updatedrequired | integer |
enrolledrequired | integer |
parentsLinkedrequired | integer |
errorsrequired | list of object |
notesrequired | list of object |
dryRunrequired | boolean |
Courses
get/v1/coursesList courses
Answer
| Field | Type |
|---|---|
itemsrequired | list of object |
post/v1/coursesCreate a course
Body
| Field | Type |
|---|---|
titlerequired | string |
kind | one of: "group", "one_to_one", "recorded" |
description | string or null |
color | string or null |
maxLearners | integer or null |
admissionsOpen | boolean |
startsOn | string or null |
endsOn | string or null |
defaultProvider | one of: "google_meet", "zoom", "external", "in_person", "paadam_live" |
defaultDurationMin | integer |
defaultLocation | string or null |
defaultExternalUrl | string (uri) or null |
whatsappGroupId | string or null |
shareRecordings | boolean |
certificate | object |
tutorIds | list of string (uuid) |
Answer
| Field | Type |
|---|---|
idrequired | string (uuid) |
titlerequired | string |
kindrequired | one of: "group", "one_to_one", "recorded" |
statusrequired | one of: "active", "archived" |
descriptionrequired | string or null |
colorrequired | string or null |
maxLearnersrequired | integer or null |
admissionsOpenrequired | boolean |
startsOnrequired | string or null |
endsOnrequired | string or null |
defaultProviderrequired | one of: "google_meet", "zoom", "external", "in_person", "paadam_live" |
defaultDurationMinrequired | integer |
defaultLocationrequired | string or null |
defaultExternalUrlrequired | string or null |
whatsappGroupIdrequired | string or null |
shareRecordingsrequired | boolean |
certificaterequired | object |
createdAtrequired | string |
tutorsrequired | list of object |
learnerCountrequired | integer |
nextClassAtrequired | string or null |
get/v1/courses/{id}One course
Answer
| Field | Type |
|---|---|
idrequired | string (uuid) |
titlerequired | string |
kindrequired | one of: "group", "one_to_one", "recorded" |
statusrequired | one of: "active", "archived" |
descriptionrequired | string or null |
colorrequired | string or null |
maxLearnersrequired | integer or null |
admissionsOpenrequired | boolean |
startsOnrequired | string or null |
endsOnrequired | string or null |
defaultProviderrequired | one of: "google_meet", "zoom", "external", "in_person", "paadam_live" |
defaultDurationMinrequired | integer |
defaultLocationrequired | string or null |
defaultExternalUrlrequired | string or null |
whatsappGroupIdrequired | string or null |
shareRecordingsrequired | boolean |
certificaterequired | object |
createdAtrequired | string |
tutorsrequired | list of object |
learnerCountrequired | integer |
nextClassAtrequired | string or null |
patch/v1/courses/{id}Change a course
Body
| Field | Type |
|---|---|
title | string |
kind | one of: "group", "one_to_one", "recorded" |
description | string or null |
color | string or null |
maxLearners | integer or null |
admissionsOpen | boolean |
startsOn | string or null |
endsOn | string or null |
defaultProvider | one of: "google_meet", "zoom", "external", "in_person", "paadam_live" |
defaultDurationMin | integer |
defaultLocation | string or null |
defaultExternalUrl | string (uri) or null |
whatsappGroupId | string or null |
shareRecordings | boolean |
certificate | object |
status | one of: "active", "archived" |
Answer
| Field | Type |
|---|---|
idrequired | string (uuid) |
titlerequired | string |
kindrequired | one of: "group", "one_to_one", "recorded" |
statusrequired | one of: "active", "archived" |
descriptionrequired | string or null |
colorrequired | string or null |
maxLearnersrequired | integer or null |
admissionsOpenrequired | boolean |
startsOnrequired | string or null |
endsOnrequired | string or null |
defaultProviderrequired | one of: "google_meet", "zoom", "external", "in_person", "paadam_live" |
defaultDurationMinrequired | integer |
defaultLocationrequired | string or null |
defaultExternalUrlrequired | string or null |
whatsappGroupIdrequired | string or null |
shareRecordingsrequired | boolean |
certificaterequired | object |
createdAtrequired | string |
tutorsrequired | list of object |
learnerCountrequired | integer |
nextClassAtrequired | string or null |
get/v1/courses/{id}/learnersA course's learners
Answer
| Field | Type |
|---|---|
itemsrequired | list of object |
post/v1/courses/{id}/learnersAdd learners to a course
Body
| Field | Type |
|---|---|
userIdsrequired | list of string (uuid) |
expiresAt | string (date-time) or null |
Answer
| Field | Type |
|---|---|
addedrequired | integer |
get/v1/courses/{id}/learners/{userId}/removalWhat removing a learner would do to their fees
Which of their orders would stop (with what's still due, and the last payment refund=1 would give back) and which would go on. Owners and admins. Changes nothing.
Answer
| Field | Type |
|---|---|
stoppingOrdersrequired | list of object |
continuingOrdersrequired | list of object |
refundablePaiserequired | integer |
delete/v1/courses/{id}/learners/{userId}Remove a learner from a course
Also stops what they pay for it: an order for this course alone is cancelled (what's still due, and its autopay). A bundle that covers other courses they're still in keeps billing. Nothing is refunded unless refund=1: then the last payment on each order that stops is refunded (through the gateway, or recorded as given back when it was paid offline), and each stopped order says how that went: done, pending (the gateway hasn't confirmed; refunding the payment again finishes it) or failed (with the reason). Never a bundle's that goes on.
Query
refund | one of: "0", "1" |
Answer
| Field | Type |
|---|---|
stoppedOrdersrequired | list of object |
continuingOrdersrequired | list of object |
noterequired | string or null |
Classes
get/v1/classesClasses between two times
Query
from | string (date-time) |
to | string (date-time) |
courseId | string (uuid) |
tutorId | string (uuid) |
learnerId | string (uuid) |
status | one of: "scheduled", "live", "completed", "cancelled" |
Answer
| Field | Type |
|---|---|
itemsrequired | list of object |
post/v1/classesSchedule a class
Checks clashes (tutor busy or on leave, holidays, learners in two places) unless force is set.
Body
| Field | Type |
|---|---|
courseIdrequired | string (uuid) |
titlerequired | string |
description | string or null |
tutorId | string (uuid) or null |
provider | one of: "google_meet", "zoom", "external", "in_person", "paadam_live" |
location | string or null |
joinUrl | string (uri) or null |
durationMin | integer |
startsAtrequired | string (date-time) |
force | boolean |
Answer
| Field | Type |
|---|---|
idrequired | string (uuid) |
courseIdrequired | string (uuid) |
courseTitlerequired | string |
courseColorrequired | string or null |
seriesIdrequired | string (uuid) or null |
tutorrequired | object or null |
titlerequired | string |
descriptionrequired | string or null |
startsAtrequired | string |
endsAtrequired | string |
statusrequired | one of: "scheduled", "live", "completed", "cancelled" |
providerrequired | one of: "google_meet", "zoom", "external", "in_person", "paadam_live" |
joinUrlrequired | string or null |
locationrequired | string or null |
startedAtrequired | string or null |
endedAtrequired | string or null |
cancelReasonrequired | string or null |
attendancerequired | object or null |
myAttendancerequired | one of: "present", "late", "absent", "excused" or null |
hasReportrequired | boolean |
recordingCountrequired | integer |
post/v1/class-seriesSchedule repeating classes
Body
| Field | Type |
|---|---|
courseIdrequired | string (uuid) |
title | string |
numberFrom | integer |
weekdaysrequired | list of integer |
startTimerequired | string |
durationMinrequired | integer |
startsOnrequired | string |
endsOn | string or null |
occurrences | integer or null |
tutorId | string (uuid) or null |
provider | one of: "google_meet", "zoom", "external", "in_person", "paadam_live" |
location | string or null |
joinUrl | string (uri) or null |
skipHolidays | boolean |
force | boolean |
Answer
| Field | Type |
|---|---|
seriesIdrequired | string (uuid) |
createdrequired | integer |
skippedHolidaysrequired | list of string |
skippedPastrequired | list of string |
conflictsrequired | list of object |
post/v1/class-series/{id}/cancelCancel the rest of a series
Body
| Field | Type |
|---|---|
from | string (date-time) |
reason | string |
notify | boolean |
Answer
| Field | Type |
|---|---|
cancelledrequired | integer |
get/v1/classes/{id}One class
Answer
| Field | Type |
|---|---|
idrequired | string (uuid) |
courseIdrequired | string (uuid) |
courseTitlerequired | string |
courseColorrequired | string or null |
seriesIdrequired | string (uuid) or null |
tutorrequired | object or null |
titlerequired | string |
descriptionrequired | string or null |
startsAtrequired | string |
endsAtrequired | string |
statusrequired | one of: "scheduled", "live", "completed", "cancelled" |
providerrequired | one of: "google_meet", "zoom", "external", "in_person", "paadam_live" |
joinUrlrequired | string or null |
locationrequired | string or null |
startedAtrequired | string or null |
endedAtrequired | string or null |
cancelReasonrequired | string or null |
attendancerequired | object or null |
myAttendancerequired | one of: "present", "late", "absent", "excused" or null |
hasReportrequired | boolean |
recordingCountrequired | integer |
reportrequired | object or null |
myRatingrequired | integer or null |
ratingSummaryrequired | object or null |
canRaterequired | boolean |
patch/v1/classes/{id}Move or change a class
Body
| Field | Type |
|---|---|
title | string |
description | string or null |
tutorId | string (uuid) or null |
provider | one of: "google_meet", "zoom", "external", "in_person", "paadam_live" |
location | string or null |
joinUrl | string (uri) or null |
startsAt | string (date-time) |
durationMin | integer |
force | boolean |
Answer
| Field | Type |
|---|---|
idrequired | string (uuid) |
courseIdrequired | string (uuid) |
courseTitlerequired | string |
courseColorrequired | string or null |
seriesIdrequired | string (uuid) or null |
tutorrequired | object or null |
titlerequired | string |
descriptionrequired | string or null |
startsAtrequired | string |
endsAtrequired | string |
statusrequired | one of: "scheduled", "live", "completed", "cancelled" |
providerrequired | one of: "google_meet", "zoom", "external", "in_person", "paadam_live" |
joinUrlrequired | string or null |
locationrequired | string or null |
startedAtrequired | string or null |
endedAtrequired | string or null |
cancelReasonrequired | string or null |
attendancerequired | object or null |
myAttendancerequired | one of: "present", "late", "absent", "excused" or null |
hasReportrequired | boolean |
recordingCountrequired | integer |
post/v1/classes/{id}/cancelCancel a class
Learners and parents are told on the institute's channels.
Body
| Field | Type |
|---|---|
reason | string |
notify | boolean |
Answer
| Field | Type |
|---|---|
idrequired | string (uuid) |
courseIdrequired | string (uuid) |
courseTitlerequired | string |
courseColorrequired | string or null |
seriesIdrequired | string (uuid) or null |
tutorrequired | object or null |
titlerequired | string |
descriptionrequired | string or null |
startsAtrequired | string |
endsAtrequired | string |
statusrequired | one of: "scheduled", "live", "completed", "cancelled" |
providerrequired | one of: "google_meet", "zoom", "external", "in_person", "paadam_live" |
joinUrlrequired | string or null |
locationrequired | string or null |
startedAtrequired | string or null |
endedAtrequired | string or null |
cancelReasonrequired | string or null |
attendancerequired | object or null |
myAttendancerequired | one of: "present", "late", "absent", "excused" or null |
hasReportrequired | boolean |
recordingCountrequired | integer |
get/v1/classes/{id}/attendanceA class's attendance
Answer
| Field | Type |
|---|---|
itemsrequired | list of object |
put/v1/classes/{id}/attendanceMark attendance
Body
| Field | Type |
|---|---|
entriesrequired | list of object |
Answer
| Field | Type |
|---|---|
itemsrequired | list of object |
get/v1/courses/{id}/recordingsA course's recordings
Answer
| Field | Type |
|---|---|
itemsrequired | list of object |
post/v1/courses/{id}/recordingsAdd a recording
Body
| Field | Type |
|---|---|
titlerequired | string |
urlrequired | string (uri) |
sessionId | string (uuid) or null |
published | boolean |
Answer
| Field | Type |
|---|---|
idrequired | string (uuid) |
courseIdrequired | string (uuid) |
sessionIdrequired | string (uuid) or null |
sessionStartsAtrequired | string or null |
titlerequired | string |
providerrequired | one of: "google_drive", "zoom", "vimeo", "youtube", "bunny", "link", "paadam" |
urlrequired | string |
durationSecondsrequired | integer or null |
statusrequired | one of: "processing", "ready", "failed" |
publishedrequired | boolean |
notesrequired | one of: "queued", "processing", "ready", "failed" or null |
resumerequired | object or null |
createdAtrequired | string |
Sales and fees
get/v1/ordersList orders
Query
status | one of: "pending", "active", "paid", "cancelled", "refunded" |
q | string |
productId | string (uuid) |
userId | string (uuid) |
from | string (date) |
to | string (date) |
page | integer |
pageSize | integer |
Answer
| Field | Type |
|---|---|
itemsrequired | list of object |
totalrequired | integer |
post/v1/ordersSell something by hand
A walk-in or a phone sale, optionally with its first payment.
Body
| Field | Type |
|---|---|
userIdrequired | string (uuid) |
planIdrequired | string (uuid) |
couponCode | string or null |
extraDiscountPaise | integer |
note | string or null |
firstPayment | object or null |
Answer
| Field | Type |
|---|---|
idrequired | string (uuid) |
numberrequired | integer |
statusrequired | one of: "pending", "active", "paid", "cancelled", "refunded" |
userrequired | object |
productIdrequired | string (uuid) or null |
productTitlerequired | string |
planNamerequired | string |
planKindrequired | one of: "one_time", "instalments", "subscription" |
subtotalPaiserequired | integer |
discountPaiserequired | integer |
walletPaiserequired | integer |
totalPaiserequired | integer |
paidPaiserequired | integer |
balancePaiserequired | integer |
couponCoderequired | string or null |
affiliaterequired | string or null |
billingrequired | object |
sourcerequired | object |
duesrequired | list of object |
paymentsrequired | list of object |
autopayrequired | object or null |
autopayAvailablerequired | boolean |
noterequired | string or null |
createdAtrequired | string |
paidAtrequired | string or null |
get/v1/orders/{id}One order
Answer
| Field | Type |
|---|---|
idrequired | string (uuid) |
numberrequired | integer |
statusrequired | one of: "pending", "active", "paid", "cancelled", "refunded" |
userrequired | object |
productIdrequired | string (uuid) or null |
productTitlerequired | string |
planNamerequired | string |
planKindrequired | one of: "one_time", "instalments", "subscription" |
subtotalPaiserequired | integer |
discountPaiserequired | integer |
walletPaiserequired | integer |
totalPaiserequired | integer |
paidPaiserequired | integer |
balancePaiserequired | integer |
couponCoderequired | string or null |
affiliaterequired | string or null |
billingrequired | object |
sourcerequired | object |
duesrequired | list of object |
paymentsrequired | list of object |
autopayrequired | object or null |
autopayAvailablerequired | boolean |
noterequired | string or null |
createdAtrequired | string |
paidAtrequired | string or null |
get/v1/duesInstalments still to be paid
Query
overdue | one of: "0", "1" |
q | string |
page | integer |
Answer
| Field | Type |
|---|---|
itemsrequired | list of object |
totalrequired | integer |
totalPaiserequired | integer |
post/v1/payments/offlineRecord a payment made outside the app
Body
| Field | Type |
|---|---|
dueIdsrequired | list of string (uuid) |
methodrequired | one of: "cash", "upi", "bank_transfer", "cheque", "card", "other" |
reference | string or null |
paidOn | string (date) |
note | string or null |
Answer
| Field | Type |
|---|---|
paymentIdrequired | string (uuid) |
post/v1/payments/{id}/refundRefund a payment
Record a refund made at the gateway or by hand; optionally end the learner's access.
Body
| Field | Type |
|---|---|
amountPaise | integer |
reason | string or null |
endAccess | boolean |
Answer
| Field | Type |
|---|---|
ordersrequired | list of object |
get/v1/invoicesInvoices
Query
from | string (date) |
to | string (date) |
page | integer |
Answer
| Field | Type |
|---|---|
itemsrequired | list of object |
totalrequired | integer |
get/v1/leadsEnquiries
Query
status | one of: "new", "contacted", "converted", "lost" |
q | string |
page | integer |
Answer
| Field | Type |
|---|---|
itemsrequired | list of object |
totalrequired | integer |
post/v1/leadsAdd an enquiry
From your own website form or ads. Sent on to the CRM webhook and the lead.created event.
Body
| Field | Type |
|---|---|
namerequired | string |
phonerequired | string |
email | string (email) or null |
productId | string (uuid) or null |
message | string or null |
source | object |
website | string |
Answer
| Field | Type |
|---|---|
okrequired | true |
post/v1/leads/importBring in enquiries from a spreadsheet or another CRM
Up to 5,000 at a time; anyone already in Enquiries (same phone or email) is skipped. Nobody is messaged. Set dryRun to check the rows first.
Body
| Field | Type |
|---|---|
rowsrequired | list of object |
dryRun | boolean |
Answer
| Field | Type |
|---|---|
createdrequired | integer |
skippedrequired | integer |
errorsrequired | list of object |
notesrequired | list of object |
dryRunrequired | boolean |
patch/v1/leads/{id}Update an enquiry
Body
| Field | Type |
|---|---|
status | one of: "new", "contacted", "converted", "lost" |
note | string or null |
Answer
| Field | Type |
|---|---|
idrequired | string (uuid) |
namerequired | string |
phonerequired | string or null |
emailrequired | string or null |
productTitlerequired | string or null |
messagerequired | string or null |
sourcerequired | object |
statusrequired | one of: "new", "contacted", "converted", "lost" |
noterequired | string or null |
createdAtrequired | string |
Messages
get/v1/announcementsAnnouncements sent
Answer
| Field | Type |
|---|---|
itemsrequired | list of object |
post/v1/announcementsSend an announcement
To learners, parents or tutors (all, or some courses), in the app and by push, WhatsApp, SMS or email.
Body
| Field | Type |
|---|---|
titlerequired | string |
bodyrequired | string |
audiencerequired | object |
channelsrequired | list of one of: "app", "push", "whatsapp", "sms", "email" |
Answer
| Field | Type |
|---|---|
titlerequired | string |
bodyrequired | string |
audiencerequired | object |
channelsrequired | list of one of: "app", "push", "whatsapp", "sms", "email" |
idrequired | string (uuid) |
sentByrequired | string or null |
recipientsrequired | integer or null |
createdAtrequired | string |
Forms
get/v1/formsList forms
Answer
| Field | Type |
|---|---|
itemsrequired | list of object |
get/v1/forms/{id}One form with its questions
Answer
| Field | Type |
|---|---|
idrequired | string (uuid) |
titlerequired | string |
slugrequired | string |
statusrequired | one of: "draft", "open", "closed" |
responsesrequired | integer |
lastResponseAtrequired | string or null |
createdAtrequired | string |
descriptionrequired | string |
fieldsrequired | list of object |
settingsrequired | object |
urlrequired | string |
updatedAtrequired | string |
get/v1/forms/{id}/responsesA form's responses
Newest first; search by name, phone, email or any answer. Up to 1000 a page.
Query
q | string |
page | integer |
limit | integer |
Answer
| Field | Type |
|---|---|
itemsrequired | list of object |
totalrequired | integer |
get/v1/forms/{id}/responses/{responseId}One response
Answer
| Field | Type |
|---|---|
idrequired | string (uuid) |
createdAtrequired | string |
namerequired | string or null |
emailrequired | string or null |
phonerequired | string or null |
personrequired | object or null |
leadIdrequired | string (uuid) or null |
answersrequired | list of object |
Agreements
get/v1/agreementsList agreements
Answer
| Field | Type |
|---|---|
itemsrequired | list of object |
post/v1/agreements/{id}/sendAsk people to sign
Particular learners or parents, or everyone in a course (or their parents). Nobody is asked twice.
Body
| Field | Type |
|---|---|
userIds | list of string (uuid) |
courseId | string (uuid) or null |
to | one of: "learners", "parents", "both" |
Answer
| Field | Type |
|---|---|
sentrequired | integer |
skippedrequired | integer |
get/v1/agreements/{id}/requestsWho was asked, and who signed
Answer
| Field | Type |
|---|---|
itemsrequired | list of object |
get/v1/agreement-requests/{id}/signedA signed copy
The exact text signed, the typed and drawn signature, when, and from where.
Answer
| Field | Type |
|---|---|
idrequired | string (uuid) |
instituteNamerequired | string |
titlerequired | string |
bodyrequired | string |
signerrequired | object |
learnerNamerequired | string or null |
signedNamerequired | string |
signaturerequired | string or null |
signedAtrequired | string |
iprequired | string or null |
userAgentrequired | string or null |
bodyHashrequired | string |
Analytics
get/v1/analytics/overviewHow the institute did over a period
Query
from | string (date) |
to | string (date) |
Answer
| Field | Type |
|---|---|
fromrequired | string (date) |
torequired | string (date) |
previousFromrequired | string (date) |
previousTorequired | string (date) |
learnersrequired | object |
classesrequired | object |
learningrequired | object |
moneyrequired | object or null |
bucketrequired | one of: "day", "week", "month" |
trendrequired | list of object |
storagerequired | object or null |
get/v1/analytics/coursesEach course over a period
Query
from | string (date) |
to | string (date) |
Answer
| Field | Type |
|---|---|
fromrequired | string (date) |
torequired | string (date) |
itemsrequired | list of object |
get/v1/analytics/courses/{id}One batch: attendance, progress and fees per learner
Query
from | string (date) |
to | string (date) |
Answer
| Field | Type |
|---|---|
fromrequired | string (date) |
torequired | string (date) |
courserequired | object |
summaryrequired | object |
sessionsrequired | list of object |
learnersrequired | list of object |
get/v1/analytics/learnersLearners and who needs attention
Query
from | string (date) |
to | string (date) |
courseId | string (uuid) |
risk | one of: "1", "attendance", "inactive", "fees", "scores" |
q | string |
sort | one of: "name", "attendance", "lastActive", "score" |
page | integer |
all | one of: "1" |
Answer
| Field | Type |
|---|---|
fromrequired | string (date) |
torequired | string (date) |
itemsrequired | list of object |
totalrequired | integer |
riskCountsrequired | object |
pageSizerequired | integer |
Webhooks
get/v1/webhook-eventsEvery event a webhook can receive
Answer
| Field | Type |
|---|---|
itemsrequired | list of object |
post/v1/webhooksSubscribe an address to events
Empty events means every event. The secret in the reply signs every delivery; it is only shown here. Zapier and n8n triggers subscribe this way and unsubscribe with DELETE.
Body
| Field | Type |
|---|---|
urlrequired | string (uri) |
description | string |
events | list of one of: "member.created", "member.updated", "enrollment.created", "enrollment.ended", "course.created", "course.updated", "class.scheduled", "class.updated", "class.cancelled", "class.started", "class.ended", "attendance.marked", "recording.added", "test.submitted", "test.graded", "certificate.issued", "order.created", "payment.paid", "payment.refunded", "lead.created", "progress_report.published", "announcement.sent", "form.submitted", "agreement.signed" |
Answer
| Field | Type |
|---|---|
endpointrequired | object |
secretrequired | string |
get/v1/webhooksList webhooks (signed-in staff)
Answer
| Field | Type |
|---|---|
itemsrequired | list of object |
patch/v1/webhooks/{id}Change a webhook (signed-in staff)
Body
| Field | Type |
|---|---|
url | string (uri) |
description | string |
events | list of one of: "member.created", "member.updated", "enrollment.created", "enrollment.ended", "course.created", "course.updated", "class.scheduled", "class.updated", "class.cancelled", "class.started", "class.ended", "attendance.marked", "recording.added", "test.submitted", "test.graded", "certificate.issued", "order.created", "payment.paid", "payment.refunded", "lead.created", "progress_report.published", "announcement.sent", "form.submitted", "agreement.signed" |
enabled | boolean |
Answer
| Field | Type |
|---|---|
idrequired | string (uuid) |
urlrequired | string |
descriptionrequired | string |
eventsrequired | list of one of: "member.created", "member.updated", "enrollment.created", "enrollment.ended", "course.created", "course.updated", "class.scheduled", "class.updated", "class.cancelled", "class.started", "class.ended", "attendance.marked", "recording.added", "test.submitted", "test.graded", "certificate.issued", "order.created", "payment.paid", "payment.refunded", "lead.created", "progress_report.published", "announcement.sent", "form.submitted", "agreement.signed" |
enabledrequired | boolean |
disabledReasonrequired | string or null |
failingSincerequired | string or null |
lastSuccessAtrequired | string or null |
createdAtrequired | string |
delete/v1/webhooks/{id}Unsubscribe
Answers 204 with no body.
post/v1/webhooks/{id}/rotateNew signing secret (signed-in staff)
Answer
| Field | Type |
|---|---|
secretrequired | string |
get/v1/webhooks/{id}/deliveriesWhat was sent, and what came back (signed-in staff)
Query
status | one of: "pending", "delivered", "failed" |
before | string (uuid) |
Answer
| Field | Type |
|---|---|
itemsrequired | list of object |
hasMorerequired | boolean |
post/v1/webhooks/{id}/testSend a test event (signed-in staff)
Answer
| Field | Type |
|---|---|
idrequired | string (uuid) |
eventIdrequired | string (uuid) |
eventrequired | string |
statusrequired | one of: "pending", "delivered", "failed" |
attemptsrequired | integer |
nextAttemptAtrequired | string or null |
responseStatusrequired | integer or null |
responseBodyrequired | string or null |
errorrequired | string or null |
durationMsrequired | integer or null |
createdAtrequired | string |
deliveredAtrequired | string or null |
payloadrequired | object |