Skip to main content
Light

API Documentation

Use the IntelliPlan REST API to read assignments, create tasks, generate schedules, and access study data.

Authentication

All protected endpoints use a Bearer token. Create one with your IntelliPlan email and password.

POST /api/v1/auth/token
Content-Type: application/json

{
  "email": "student@example.com",
  "password": "your-password"
}

Send the returned token as Authorization: Bearer TOKEN.

Core Endpoints

GET /api/v1/meReturn the authenticated user profile.
GET /api/v1/assignmentsReturn the unified assignment list from Canvas, StudentVUE, Notion, and manual tasks.
POST /api/v1/tasksCreate a manual task with title, due date, priority, course, estimated time, and notes.
POST /api/v1/schedule/generateGenerate a study schedule from connected assignments or a provided assignment list.
GET /api/v1/streakReturn Sparks, streak, level, quests, and reward state.
GET /api/v1/identityReturn the student's learning profile.
PATCH /api/v1/identityUpdate grade level, focus areas, goals, commitments, or availability.

IndexNow (search engine notifications)

IntelliPlan hosts an IndexNow verification key and can notify participating search engines when public URLs change. See the full protocol guide at /indexnow.

GET /<INDEXNOW_KEY>.txtOwnership verification key file (hosted at site root).
POST /api/admin/indexnow/submitAdmin only — bulk submit URLs from JSON {"urls":[...]} or entire sitemap when omitted.
GET /api/admin/indexnow/submit?url=...Admin only — submit a single URL (IndexNow GET format).
GET /api/admin/indexnow/statusAdmin only — show key, host, endpoint, and sitemap URL count.

Example

curl -H "Authorization: Bearer $INTELLIPLAN_TOKEN" \
  https://intelliplan.tech/api/v1/assignments

The machine-readable API index is available at /api/v1/docs.