Install our app for a better experience!
API Reference

API Reference

Endpoints, payloads, responses, error codes and idempotency.

6 Pages
0 Videos
0 FAQs
Reference

API Endpoints & Payloads

# API Reference **Base URL:** `https:///api/v1/` Every request needs your organization's API key in a header: ``` X-…

12 min read Intermediate
api endpoints payload reference idempotency course types organization courses students email status errors
Reference

Content Publishing API (Blog & Pages)

# Content Publishing API (Blog & Pages) Publish and update blog posts and custom marketing pages programmatically — in…

7 min read Intermediate
blog pages content publishing api faqs citations key takeaways schema seo aeo x-api-key
Reference

Results & Progress API

# Results & Progress API Bring your students' PrepareBuddy scores into your own system — a CRM, a student information …

8 min read Intermediate
results scores progress trend daily sync export cursor language tests quizzes assessments api
Reference

Webhooks — Results Pushed to Your System

# Webhooks — Events Pushed to Your System Instead of asking PrepareBuddy "anything new?" on a schedule, let PrepareBud…

8 min read Intermediate
webhooks push result.final signature hmac retries sync realtime
Reference

Roster, Assignments & Activity API

# Roster, Assignments & Activity API Keep your own systems in step with PrepareBuddy: who your students are, what is a…

7 min read Intermediate
students roster assignments overdue due date activity attendance engagement time on platform api
Reference

Target Score Plans through the API

# Target Score Plans through the API For institutes that use the **Target Score Tracker**. The same call that onboards…

8 min read Intermediate
target score test plan target score tracker ielts sat exam date pace safe exam browser provisioning target_score_plan api