Skip to main content
An Export is a CSV of one of an account’s dashboard tables, such as members, payments, or disputes. Exports are generated in the background, so a new export starts pending and becomes completed with a download link. Use the Exports API to start an export, poll it until download_url is set, and list an account’s past exports. Each table requires its own export scope, and finished files are deleted after 30 days.

Endpoints

Attributes

string
required
Export ID, prefixed exprt_.
string
required
When the export was requested, as an ISO 8601 timestamp.
string | null
required
A short-lived link to download the finished file. null until status is completed, and again once the export has expired.
string
required
When the file is deleted and the export moves to expired, as an ISO 8601 timestamp. Exports are retained for 30 days.
integer | null
required
Estimated completion percentage from 0 to 100.
string
required
The resource that was exported, e.g. receipts, members, or payouts.Available options: ad_campaigns, ad_groups, ads, apps, audiences, bounties, bounty_submissions, card_transactions, checkout_configurations, disputes, events, external_accounts, financial-activity, payout_methods, payouts, people, plans, products, resolution_center_cases, shipments, social_accounts, team_members, transfers, webhooks, members, receipts, unclaimed_memberships, memberships, tracking_links, promo_codes, resolutions, entries, leads, invoices, cancelation_reasons, child_companies, ledger_lines, withdrawal_lines
string
required
pending or processing while the file is generated, completed when the download is ready, failed if it errored, expired once the file has been deleted.Available options: pending, processing, completed, failed, expired
string
required
When the export last changed, as an ISO 8601 timestamp.
Export