Skip to main content
GET
Export Deals

Request

Returns a CSV file of deals matching the query. Response is streamed with Content-Type: text/csv; charset=utf-8.

Query Parameters

integer
default:"10000"
Maximum rows to return. Maximum 50,000 per request.
string
Scope the export to a single pipeline.
string
Scope the export to a single pipeline stage.
string
Filter by status: open, won, or lost.
string
ISO 8601 lower bound on created_at.
string
ISO 8601 upper bound on created_at.
string
Comma-separated field whitelist. Defaults to id,name,pipeline_id,stage_id,status,value,currency,company_name,owner_email,created_at,closed_at.

Headers

Response

CSV stream with Content-Disposition: attachment; filename="deals-export.csv". First row is headers. Responses include X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, and X-Request-ID.

Example Response

Errors