API & integrations
API keys, calling the API, webhooks, and which to use.
Start here
API
- Create, copy and revoke API keysGive a trusted tool read access to your school’s data with a key you can revoke at any time. Owner only, on any paid plan.
- Call the API: address, key, pages, errors and limitsFor developers: the base address, the Authorization header, the key check, paging through lists, the error format and the request limit.
- Connect Zinstruct to an AI assistant (MCP)Let ChatGPT, Claude, Cursor or another MCP-capable assistant read your school’s contacts, products, enrollments and course engagement. Connect by signing in, or with an API key.
- Read contacts, products, offers and enrollments with the APIThe Core data requests: list or fetch contacts, products, offers and enrollments with an API key, with filters and paging.
- Pull engagement reports with the APIThe Engagement requests: your headline numbers, engagement per course and module, student activity and watch history, and where viewers drop off lessons.
- Manage contacts, offers and webhook endpoints with the signed-in JSON APIThe JSON API that works with your own sign-in instead of a key: how to call it, what each role can do, and the contacts, offers and webhook endpoint requests.
- Build courses with the signed-in JSON APIRead and build products, modules and lessons, enroll contacts and mark lessons complete with the JSON API that uses your sign-in.
Webhooks
- Set up webhooksSend events to your own systems as they happen: add an endpoint, pick its events, and manage, pause, rotate or delete it. Professional plan.
- Receive webhooks: signatures, retries and resendingWhat each webhook delivery contains, how to check its signature, how retries work, and how to read the delivery log and resend a delivery.
Still stuck? Talk to a human.
Email support@zinstruct.com. We reply within one business day, Monday to Friday, 9 a.m. to 5 p.m. US Mountain Time. Already signed in? Ask from the help button inside the app.