Get Export
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 requested earlier.
Only the household owner can access it, including when subscription access has lapsed. Private download URLs can expire before the archive; retrieve the export again for a fresh URL. Download before expires_at; purged exports return export_not_found.
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 GET "https://example.com/v1/households/string/exports/string"{ "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"}