leads
leads

Export Leads

Export selected leads as CSV or JSON, uploaded to S3 (or local tmp/ in dev).

Accepts the admin key OR the read-only key — an export is the same full-fidelity read the read-only key already has, materialized as a file. Outward dispatch (to_email) stays admin-only.

Returns a presigned URL valid for 72 hours. Optionally emails the link via SES if to_email is provided (admin key required).

Provide entity_ids for specific leads, or set include_all_matching=True (optionally with state + filters) to export all matching leads. Omitting state exports the matching cohort across every live state, same as an "All States" Browse.

post/api/v1/leads/export

Request

  • Base URL: https://app.goodleads.club (the document declares no server; this is the origin it was published from)
  • URL: https://app.goodleads.club/api/v1/leads/export
  • Auth: API key in header X-API-Key

Request body

statestring nullable
entity_idsstring[] nullable
include_all_matchingboolean
filtersobject[]
format'csv' | 'json' | 'xlsx'
to_emailstring nullable
include_non_operatingboolean
include_existingboolean
include_registrationsboolean
audience'customer' | 'design_partner' | 'data_partner'
licensed_tostring nullable
cohort_notestring nullable

Response

Successful Response

unknown required

Changes

No recorded changes to this operation across all 1 revision of this API.