How to Create an API Key

API keys let you connect ChoreSplit to other apps like Home Assistant, Zapier, or custom scripts.

Prerequisites

• Premium subscription — API access is a premium feature
• Parent role — Only parents can create API keys

Steps

1. Go to Family Settings — Tap Family in navigation

2. Find "API Keys" — Scroll to the API Keys section

3. Tap "Create API Key" — Click the create button

4. Configure your key:

   • Name: What's this key for? (e.g., "Home Assistant")
   • Permission: Read (view only) or Write (full access)

5. Tap "Create" — Your key is generated

6. Copy the key — Save it securely! It won't be shown again.

Permission Levels

Permission	Access
Read	View tasks, assignments, members, stats
Write	Read access + create, update, delete

Security Tips

• Never share your API key publicly
• Use read-only keys when possible
• Regenerate keys if compromised
• Delete unused keys

Troubleshooting

Can't find API Keys section? API access requires a Premium subscription. Upgrade to unlock this feature.

Key not working? Make sure the key has the correct permission level for your use case. Read keys can't make changes.