FamilyDesk

Household API

Create a household API key in Manage, then call HTTPS JSON routes with a bearer token. The website and API share the same Convex household data.

Quickstart

  1. Sign in as the household owner and open API access.
  2. Create a key, copy it once, and store it in an environment variable.
  3. Call https://familydesk.ph/api/v1 with Authorization: Bearer $FAMILYDESK_API_KEY.
  4. Send Idempotency-Key on creates and consequential actions.
  5. Revoke the key from the same screen when finished.
export FAMILYDESK_API_KEY="fdk_..."
curl -sS https://familydesk.ph/api/v1/household \
  -H "Authorization: Bearer $FAMILYDESK_API_KEY"

OpenAPI 3.1: /docs/household-api/openapi.json