Request Export
Queues a ZIP archive of the household's data and returns 202 with the export record. Only the household owner can request an export, including when subscription access has lapsed.
Poll the export's retrieval endpoint until its status is completed or failed. A completed export includes a download URL and is retained for seven days. Only one export can be pending or processing per household; another request during that time returns export_in_progress.
Authorization
PersonalApiToken Use your personal API token (penny_pat_…) as the bearer credential. Enter the token only; the client adds the Bearer prefix. Read-only tokens permit read requests. Read/write tokens remain limited by your current household membership and role. See https://penny.finance/docs/api#authentication for setup.
In: header
Path Parameters
Response Body
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/households/string/exports"{ "id": "Ex7mQ2vK9pLd", "status": "pending", "requested_by_email": "user@example.com", "file_size_bytes": 2487316, "download_url": "https://downloads.penny.finance/exports/Ex7mQ2vK9pLd.zip", "expires_at": "2019-08-24T14:15:22Z", "completed_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z"}List Exports GET
Lists the household's ten most recent export records, newest first, including their status and download URL when available. Only the household owner can…
Get Export GET
Retrieves an export's current status and, once completed, its download URL, size, completion time, and expiration time. Use this endpoint to poll an export…