Contacts

Stream a CSV export of all matching contacts

GET
/api/contacts/query-bulk-export

Streams a CSV of every contact matching the supplied filter as text/csv with Content-Disposition: attachment; filename="contacts-YYYY-MM-DD.csv". Columns: First Name, Last Name, Phone, Email, Pipeline, Stage, Created Date. Uses a Mongo cursor so even multi-thousand exports stream incrementally without buffering. Filter semantics match the other query-* endpoints, but parameters are passed as query string: stageIds is a comma-separated list, advancedParams is a JSON-encoded string (malformed JSON is silently ignored).

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Query Parameters

stageIds?string

Comma-separated pipeline-stage IDs. Required unless orgWide=true.

pipelineType?string

Which model to export from. Defaults to Contact.

Value in

  • "Contact"
  • "Application"
orgWide?string

Set to true to export across the whole organization and ignore stageIds.

Value in

  • "true"
  • "false"
ownerFilter?string

Owner-based scope (owned / unowned) applied identically to the contacts list view.

advancedParams?string

JSON-encoded filter object (same shape used by the Contacts list view advanced filters). Malformed JSON is silently ignored.

Response Body

text/csv

application/json

application/json

curl -X GET "https://example.com/api/contacts/query-bulk-export?stageIds=64b2c3d4e5f60012345678aa%2C64b2c3d4e5f60012345678ab&advancedParams=%7B%22createdAfter%22%3A%222026-01-01T00%3A00%3A00.000Z%22%7D"
"First Name,Last Name,Phone,Email,Pipeline,Stage,Created Date\n\"Alex\",\"Morgan\",\"+14165550100\",\"alex.morgan@example.com\",\"Sales\",\"New Lead\",\"2026-05-20\"\n"