Penny Docs
Exports

List Exports

GET
/v1/households/{household_id}/exports

Lists the household's ten most recent export records, newest first, including their status and download URL when available.

Only the household owner can access exports, including when subscription access has lapsed. Completed archives expire seven days after completion. This endpoint does not start a new export.

Authorization

PersonalApiToken
AuthorizationBearer <token>

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

household_id*Household Id

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/v1/households/string/exports"
{  "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"    }  ]}