Documentation

Not published yet.

Kestrel’s documentation is being written. When it publishes it will be public and ungated: no partner programme, no account, no sales call to read the reference. This page is a placeholder and says so.

Status [TARGET DATE — TO CONFIRM] · Last updated [DATE]

What will be here.

Listed so you can tell us which of it you need first, and so we can be held to the list.

API referenceEach endpoint, versioned, with request and response shapes. OAuth 2.0 scopes mapped to the same record classes as the permission model. To be written

Data modelHow the person, family, enrolment and fee-payer records relate, which is the part an integrator needs before writing a line. To be written

Integration guidesLISS, Wonde, OneRoster, School Data Sync, and the finance platforms named on the integration map. To be written

Bulk export and BIDocumented feeds for Power BI and school warehouses, as a supported path. To be written

Administrator guidesRoles and permissions, code-set configuration, report cycles, the returns calendar. To be written

ChangelogWhat changed, when, and whether it breaks anything. Public. To be written

The commitment stands even while the page is empty.

We argue in two places on this site that the documentation will be open: on the security page and on the integration map. Publishing a placeholder rather than quietly dropping those links is the point: if you cannot get your own data out without asking us, it is not your data.

Need the reference before it publishes? Ask at [DOCS@ — CONFIRM] and we will send you what exists today, in whatever state it is in. That includes the parts we are not proud of.

Tell us what to write first.

Forty minutes with your integrator. Whichever document they ask for is the one we write next.

Book a walkthrough