API Reference

Michi REST API

Build custom integrations and automate your debt-aware planning workflow.

Authentication

All API endpoints require authentication via Supabase JWT tokens. Include your token in the Authorization: Bearer <token> header. Tokens are scoped to your organization with row-level security enforced at the database level.

Base URL: https://michi.jishulabs.com
GET/api/roadmaps

List all roadmaps with their epics, milestones, and sprint associations.

Query Parameters

statusstringFilter by status: active, completed, archived
project_iduuidFilter by project
POST/api/roadmaps

Create a new roadmap with sprint length, buffer, and date range configuration.

Request Body

namestringRoadmap name (required)
descriptionstringRoadmap description
start_datedateStart date in ISO format (required)
end_datedateEnd date in ISO format (required)
sprint_length_daysintegerSprint length in days (default: 14)
planning_buffer_percentagedecimalPlanning buffer % (default: 20)
GET/api/sprints

List sprints with associated tasks, capacity, and debt sprint flags.

Query Parameters

roadmap_iduuidFilter by roadmap
statusstringFilter by status: planning, active, completed
POST/api/sprints

Create a new sprint with capacity allocation and debt sprint designation.

Request Body

namestringSprint name (required)
roadmap_iduuidParent roadmap ID (required)
start_datedateSprint start date (required)
end_datedateSprint end date (required)
total_capacityintegerTotal capacity in story points
is_debt_sprintbooleanWhether this is a full debt sprint
GET/api/tasks

List tasks across sprints with type, priority, story points, and debt metadata.

Query Parameters

sprint_iduuidFilter by sprint
task_typestringFilter: feature, bug, debt, spike, chore
statusstringFilter: backlog, todo, in_progress, review, done
POST/api/tasks

Create a task with type classification, story points, and optional debt metadata.

Request Body

titlestringTask title (required)
task_typestringType: feature, bug, debt, spike, chore (required)
sprint_iduuidSprint assignment
story_pointsintegerStory point estimate
prioritystringPriority: low, medium, high, critical
debt_typestringDebt classification (for debt tasks)
debt_impactstringImpact level: low, medium, high
debt_effortintegerEffort to fix in hours
GET/api/projects

List projects with team associations, debt allocation, and sprint frequency.

Query Parameters

team_iduuidFilter by team
POST/api/projects

Create a project with custom debt allocation and sprint frequency settings.

Request Body

namestringProject name (required)
descriptionstringProject description
team_iduuidAssociated team
debt_allocation_percentagedecimalDebt allocation % (default: 20)
debt_sprint_frequencyintegerFull debt sprint every N sprints (default: 4)
GET/api/settings

Retrieve user profile and organization settings.

PUT/api/settings

Update user profile, notification preferences, and debt management settings.

Request Body

full_namestringUser display name
companystringCompany name
default_debt_allocationdecimalDefault debt allocation %
debt_sprint_frequencyintegerDefault debt sprint frequency
ai_planning_enabledbooleanEnable AI-powered planning features

Rate Limits

API requests are rate-limited to 100 requests per minute for Starter plans and 1,000 requests per minute for Pro and Enterprise plans. Rate limit headers are included in every response.

Need help with the API? Contact our team or check the documentation.