Sign in
latestOpenAPI 3.1.02026-08-163864115.7 MB

c363cb2feb95

Exports

Create Export

Starts an asynchronous CSV export of a resource for an account. Returns the export in pending; poll GET /exports/{id} until download_url is set.

post/exports

Headers

Idempotency-Keystring
Example:d9105228-4a08-46b1-8b91-42fed586d383

A unique key that makes this request safe to retry. See Idempotent requests.

Request body

account_idstring

The account to export from, prefixed biz_. Defaults to the credential's account.

columnsstring[]

Column keys to include. Empty means all columns for the resource.

filtersobject

Resource-specific filters. For native REST resources (payouts, transfers, memberships) these are the resource's own list query params; for dashboard tables they mirror the dashboard table filters.

resource'ad_campaigns' | 'ad_groups' | 'ads' | 'apps' | 'audiences' | 'bounties' | 'bounty_submissions' | 'card_transactions' | 'checkout_configurations' | 'disputes' | 'events' | 'financial-activity' | 'members' | 'memberships' | 'payout_methods' | 'payouts' | 'people' | 'plans' | 'products' | 'resolution_center_cases' | 'shipments' | 'social_accounts' | 'team_members' | 'transfers' | 'webhooks' | 'receipts' | 'unclaimed_memberships' | 'tracking_links' | 'promo_codes' | 'resolutions' | 'entries' | 'leads' | 'content_rewards_submissions' | 'invoices' | 'cancelation_reasons' | 'child_companies' required

The resource to export, e.g. payouts, receipts, or members.

timezonestring

IANA timezone for date columns, e.g. America/New_York. Defaults to UTC.

Example request

{
  "account_id": "biz_xxxxxxxxxxxxxx",
  "columns": [
    "member_user_name"
  ],
  "filters": {
    "origin_id": "ldgr_x"
  },
  "resource": "transfers",
  "timezone": "America/Chicago"
}

Response

export created

created_atstring required

When the export was requested, as an ISO 8601 timestamp.

download_urlstring nullable required

A short-lived link to download the finished CSV. null until status is completed, and again once the export has expired.

expires_atstring required

When the CSV is deleted and the export moves to expired, as an ISO 8601 timestamp. Exports are retained for 30 days.

idstring required

Export ID, prefixed exprt_.

progress_percentinteger nullable required

Estimated completion percentage from 0 to 100.

resource'ad_campaigns' | 'ad_groups' | 'ads' | 'apps' | 'audiences' | 'bounties' | 'bounty_submissions' | 'card_transactions' | 'checkout_configurations' | 'disputes' | 'events' | 'financial-activity' | 'members' | 'memberships' | 'payout_methods' | 'payouts' | 'people' | 'plans' | 'products' | 'resolution_center_cases' | 'shipments' | 'social_accounts' | 'team_members' | 'transfers' | 'webhooks' | 'receipts' | 'unclaimed_memberships' | 'tracking_links' | 'promo_codes' | 'resolutions' | 'entries' | 'leads' | 'content_rewards_submissions' | 'invoices' | 'cancelation_reasons' | 'child_companies' | 'ledger_lines' | 'withdrawal_lines' required

The resource that was exported, e.g. receipts, members, or payouts.

status'pending' | 'processing' | 'completed' | 'failed' | 'expired' required

pending or processing while the CSV is generated, completed when the download is ready, failed if it errored, expired once the CSV has been deleted.

updated_atstring required

When the export last changed, as an ISO 8601 timestamp.

Example response

{
  "created_at": "2026-01-01T12:00:00.000Z",
  "download_url": "https://assets-2-rough.whop.com/uploads/image/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "expires_at": "2026-01-01T12:00:00.000Z",
  "id": "exprt_xxxxxxxxxxxxxx",
  "resource": "members",
  "status": "completed",
  "updated_at": "2026-01-01T12:00:00.000Z"
}