Skip to main content
GET
Export activity

Authorizations

x-conveyour-token
string
header
required

Your API key token. Contacts endpoints require a Server-only — Full API key — see Authentication.

Query Parameters

date
string

Restrict to the day range containing this date (parsed in the org's rep-bucket timezone). Also appended to the downloaded filename.

sort
string

Sort option passed through to the history query.

record_filters
string

Record-level filters applied to the exported history rows.

fields
string

Comma-separated list (or array) of fields to project when scoping contacts.

teams
string

Team id (or array of team ids) to scope contacts by team.

Contact search string. filters is accepted as an alias.

bookmark
string

Apply a saved bookmark's contact filter.

teams[]
string[]

Team scope for the request, as one or more team ObjectIds. The brackets are required: PHP keeps only the last value for a repeated plain key, so teams=A&teams=B silently resolves to B alone. On requests with a JSON body you may send teams (no brackets) in the body instead.

Values that are not valid ObjectIds are silently ignored — a mistyped team ID behaves as if no team was sent. See the teams section of the API conventions guide.

Response

A CSV file. Returns Content-Type: text/csv with a content-disposition attachment header — there is no JSON envelope on this endpoint. The file is named from the name query parameter (special characters stripped, spaces replaced), and is sent with pragma: no-cache and expires: 0.

CSV rows. Downloaded as .csv.