Endpoints Overview

API Endpoints Overview

The myumbrella.ai REST API is organized around resources. All endpoints use JSON request/response bodies and standard HTTP methods.

Base URL: https://api.myumbrella.ai/v1

Warranty Plans

Method	Endpoint	Description
GET	/plans	List all plans
POST	/plans	Create a new plan
GET	/plans/:id	Get plan details
PUT	/plans/:id	Update a plan
DELETE	/plans/:id	Archive a plan

Example: Create a Plan

curl -X POST https://api.myumbrella.ai/v1/plans \
  -H "Authorization: Bearer mu_live_abc123" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "2-Year Protection",
    "coverage": ["mechanical", "accidental"],
    "duration_months": 24,
    "price_model": "percentage",
    "rate": 0.12
  }'

Claims

Method	Endpoint	Description
GET	/claims	List claims (filterable)
POST	/claims	File a new claim
GET	/claims/:id	Get claim details
PATCH	/claims/:id	Update claim status
POST	/claims/:id/notes	Add a note to a claim

Contracts

Method	Endpoint	Description
GET	/contracts	List active contracts
GET	/contracts/:id	Get contract details
POST	/contracts/:id/cancel	Cancel a contract

Analytics

Method	Endpoint	Description
GET	/analytics/revenue	Revenue summary
GET	/analytics/claims	Claims metrics
GET	/analytics/attach-rate	Attach rate over time

Pagination

All list endpoints support cursor-based pagination:

GET /v1/plans?limit=25&starting_after=plan_xyz

Response includes has_more boolean and pagination metadata.