How to Use the ChoreSplit API

The ChoreSplit API lets you automate tasks, pull data into other apps, and build custom integrations.

Getting Started

1. Create an API key — See How to Create an API Key

2. Get the API docs — Visit choresplit.com/api/openapi.json

3. Make your first request — Try the examples below

Authentication

Include your API key in the Authorization header:

Authorization: Bearer cs_live_your_api_key_here

Common Endpoints

Get Tasks

GET /api/tasks

Returns all tasks for your family.

Get Assignments

GET /api/assignments/{weekStart}

Returns assignments for a specific week.

Complete a Task

POST /api/assignments/toggle
Body: { "assignmentId": "abc123" }

Marks a task complete (or incomplete).

Get Member Stats

GET /api/stats/{memberId}

Returns points, streaks, and achievements.

Rate Limits

• 1,000 requests per hour per API key
• Check X-RateLimit-Remaining header
• If exceeded, wait for X-RateLimit-Reset

Integration Ideas

• Home Assistant: Auto-complete tasks when sensors trigger
• Zapier: Send notifications when tasks are completed
• Smart displays: Show today's tasks on a dashboard
• Custom rewards: Trigger real-world rewards via IoT

Troubleshooting

401 Unauthorized? Check your API key is correct and hasn't been revoked.

403 Forbidden? Your key may not have write permission for this endpoint.

429 Too Many Requests? You've hit the rate limit. Wait and try again.