Kids API
Manage kids under your account. Each kid has a name, avatar, balance, and optional features like allowances, interest, savings goals, and separate checking/savings accounts.
/api/v1/kidsList all your kids with a bounded recent transaction window
[{ "id": "uuid", "name": "Rafi", "slug": "rafi", "avatar": "๐ฐ", "balance": 256.00, "checkingBalance": 200.00, "savingsBalance": 56.00, "transactions": [...] }]Returns at most 500 transactions from the last 30 days across the family. Use the single-kid endpoint for complete paginated history.
/api/v1/kids/summaryLightweight summary (for widgets/Watch)
{ "kids": [{ "name": "Rafi", "slug": "rafi", "avatar": "๐ฐ", "balance": 256.00 }], "summary": "Rafi has two hundred and fifty-six dollars. Amiel has fifty-two dollars." }/api/v1/kids/:slugPublicGet a single kid with paginated transactions
{ "kid": {...}, "settings": {...}, "pagination": { "total": 64, "limit": 20, "offset": 0 } }Public if kid profile is public. Add ?txnLimit=20&txnOffset=0 for pagination. Add ?pin=XXXX for PIN-authenticated access to private profiles.
/api/v1/kidsCreate a new kid
{ "name": "Zeke", "avatar": "๐ฆ" }{ "id": "uuid", "name": "Zeke", "slug": "zeke", "balance": 0 }/api/v1/kids/:slugUpdate a kid's settings
{ "name": "...", "avatar": "...", "savingsGoal": {...}, "recurringAllowance": {...}, "interest": {...}, "separateAccounts": true, "publicProfile": true }Only include fields you want to update. PIN-authenticated PUT (add ?pin=XXXX) is limited to savingsGoals and customAchievements.
/api/v1/kids/:slugDelete a kid and all their data
{ "success": true }This permanently deletes the kid, all transactions, and all associated data. Cannot be undone.