TypeScript SDK
Call the family plan with types.
Install a typed client with named methods generated from Mavo’s public OpenAPI contract.
Use the SDKMavo for builders
Bring the family plan into what you build.
Use the calendars, lists, people, and notifications your family already shares from a typed app, a terminal, or an HTTP client. Every interface works with the same plan your family sees in Mavo.
- A generated TypeScript SDK with named methods.
- A CLI for every documented API operation.
- A family-scoped REST API with a live OpenAPI contract.
One shared family plan
Three connections. One source of truth.
Your TypeScript appSDKMavo family plan
Your terminalCLIMavo family plan
Any HTTP clientREST APIMavo family plan
Three ways to build
Pick your interface. Keep one family plan.
The SDK and CLI are generated from the public OpenAPI contract. All three interfaces work with the same plan your family sees.
Mavo CLI
Put the plan in your terminal.
Run every documented API operation from a terminal, shell script, or CI job without assembling request paths.
Use the CLIREST API
Build directly on the contract.
Read and write documented family resources from scripts, automations, and apps with ordinary JSON.
Explore the APIOpenAPI to SDK and CLI
One contract, ready for code or shell.
Mavo generates the TypeScript SDK and CLI operation map from the same OpenAPI document as the public reference. When an endpoint changes, the generated clients have to change with it.
List family calendar eventsTypeScript
import { createMavoClient } from '@mavolife/sdk'
const mavo = createMavoClient({
apiKey: process.env.MAVO_API_KEY!,
})
const { events } = await mavo.listCalendarEvents({
path: { familySlug: 'your-family' },
query: { from: '2026-07-14' },
})The SDK has no runtime dependencies. The CLI wraps the same named operations for terminal and automation use.
Household resources
The useful parts, exposed on purpose.
Mavo exposes documented resources and named actions. It does not mirror every internal table or setting.
Calendar
Work with events, outside calendar feeds, and read-only calendar share links.
Lists and meals
Read and change groceries, meals, routines, and custom collections, including batch writes.
People and notifications
Work with household people, recent notifications, preferences, routines, and scheduled checks.
Household context
Search across supported family collections, people, and upcoming items when your tool needs context.
Send the plan outward
Stay in sync after the request ends.
Webhooks tell your endpoint what changed. iCal feeds keep the family schedule visible in calendar apps. They complement the four ways you call Mavo.
Signed webhooks
Let your tools notice what changed.
Choose the supported events your destination receives. Mavo signs the request, lets you send a test, and shows recent delivery status in Settings.
Choose eventsTest deliveryRotate secretsDelivery history
Calendar feeds
Keep the family plan visible in calendar apps.
Create an iCal share link for a Mavo calendar, then subscribe from the calendar app you already use. Calendar sync starts on Everyday and is included with Max.
See the shared calendarMax membership
Everything in Plus, plus tools for code.
- TypeScript SDK and Mavo CLI
- Family-scoped REST API keys
- Mavo access for up to 12 people
- Signed outbound webhooks
Max questions
The connection details, up front.
Which connections require Max?
The REST API, SDK, CLI, and signed webhooks require Max. Connecting a compatible assistant through MCP is free with every membership and uses Mavo sign-in instead of an API key.
Can I use an iCal feed without Max?
Yes. Calendar connections and iCal feeds are included on Everyday and higher. Max includes them alongside the API, SDK, CLI, and signed webhooks.
How are API keys scoped?
Each key belongs to one family and only works on that family’s paths. The full key is shown once when it is created, can be revoked, and is currently limited to 1,000 requests per day.
Does a connected assistant ask Mavo before every change?
No. After you approve the connection, the assistant acts as you and can make permitted changes directly. Mavo’s own chat has a separate review flow, so the connected assistant’s confirmation behavior matters.
Does the API expose everything Mavo stores?
No. It exposes documented household resources and named product actions, not every internal table or setting.
Build their plan
The useful part is that your family still sees the result.
Connect Mavo once, then let the assistant, app, script, or terminal work with the same calendar and lists everyone already shares. In Mavo, the family can ask about what changed, and Mavo’s own chat holds changes for review.
Ask Mavo
Choose a family-plan question to see the useful next step.
Practice moved to Tuesday at 5:30. Can you fix the plan?
I found Leo’s soccer practice and prepared the one-time change for you.
Move soccer practiceTue, Jul 21 · 5:30 PM · Riverside Indoor Field