Bulk export conversations with filters
Streams conversations with filters as CSV or JSON, including operator names and flattened message content.
/api/export/conversations/bulkStreams conversations with filters as CSV or JSON, including operator names and flattened message content. format defaults to csv, redact_pii defaults to false, and omitted status, operatorId, tags, dateFrom, or dateTo leave that filter unset. redact_pii=true masks recognized email addresses and phone numbers in message text. The export is audited after streaming. If the connection fails, verify whether the client received a complete attachment before starting another large export.
Endpoint requirements
- Credentials
- Use either
Bearer API keyorX-API-Key header. - Required scope
export:write- Module
- Automation & API module (
api_access) - Organization and site scope
- Requests can access only resources owned by the authenticated organization. The API does not reveal whether an identifier belongs to another organization or site.
- Retry behavior
- Non-idempotent: Repeating this request may create duplicate work or side effects. After an ambiguous timeout, check the resource state before retrying.
Query Parameters
Query parameter. Scope. Allowed values: all.
Value in
- "all"
Header Parameters
DA-4035: selects the active site (project) for project-scoped operations. Accepts a site UUID, or the literal all to aggregate across every accessible site on read-only aggregate routes (single-or-all-read). Mutations and single-site routes reject all. Path-owned project routes (/api/projects/{projectId}/…) resolve the site from the URL and ignore this header. Conflicting selectors across header/query/body/path return PROJECT_CONTEXT_CONFLICT (400); an archived site returns PROJECT_ARCHIVED (410).
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Request body accepted by this operation.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
"example"Request examples
curl
curl --request POST \
'https://api.convor.io/api/export/conversations/bulk' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer convor_sk_...' \
--header 'Content-Type: application/json' \
--data '{
"format": "csv",
"dateFrom": "2026-06-01T00:00:00.000Z",
"dateTo": "2026-06-23T23:59:59.000Z",
"status": "closed",
"operatorId": "44444444-4444-4444-8444-444444444444",
"redact_pii": true
}'JavaScript
const response = await fetch("https://api.convor.io/api/export/conversations/bulk", {
method: "POST",
headers: {
"Accept": "application/json",
"Authorization": "Bearer convor_sk_...",
"Content-Type": "application/json"
},
body: JSON.stringify({
"format": "csv",
"dateFrom": "2026-06-01T00:00:00.000Z",
"dateTo": "2026-06-23T23:59:59.000Z",
"status": "closed",
"operatorId": "44444444-4444-4444-8444-444444444444",
"redact_pii": true
}),
});
const contentType = response.headers.get("content-type") ?? "";
const data = response.status === 204
? null
: contentType.includes("json")
? await response.json()
: contentType.startsWith("text/")
? await response.text()
: await response.blob();
if (!response.ok) {
const message = typeof data === "object" && data !== null
&& "error" in data && typeof data.error === "object"
&& data.error !== null && "message" in data.error
? String(data.error.message)
: "Convor API request failed (" + response.status + ")";
throw new Error(message);
}
console.log(data);Was this page helpful?