API Keys
API keys let your own apps call ChoreBuddy without a user session. One use case is creating chores so you can track requests and feedback from clients and users.
Create an API key
- Sign in to ChoreBuddy and open the list (or workspace) where items should land.
- Open Settings.
- Expand API Keys.
- Click Create API key, give it a name, and enable Create chore.
- Copy the secret immediately. It is shown once and starts with
cb_.
Where keys live
- Standalone lists (not in a workspace): create keys under that list’s settings. The key can only create chores on that list.
- Workspace lists: create keys under the workspace settings. Choose which lists the key may access via allowed list IDs.
You can have up to 10 active keys per list or workspace.
Authenticate requests
Send the secret on every request using either header:
| Header | Value |
|---|---|
Authorization | Bearer cb_… |
x-api-key | cb_… |
Authorization: Bearer is checked first if both are present.
External API calls are rate-limited to 60 requests per minute per key.
Next step
Use the key to create chores when a client or user submits a request or feedback in your product.