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.
Bearer API key or X-API-Key header.export:writeautomation_api)application/json
TypeScript Definitions
Use the request body type in TypeScript.
Request body accepted by this operation.
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
[
{
"id": "11111111-1111-4111-8111-111111111111",
"status": "open",
"visitorId": "22222222-2222-4222-8222-222222222222",
"createdAt": "2026-07-15T10:00:00.000Z",
"updatedAt": "2026-07-15T10:30:00.000Z",
"messageCount": 1,
"messages": "[visitor] I need a copy of my invoice"
}
]{
"error": {
"code": "string",
"message": "string",
"fields": {
"property1": "string",
"property2": "string"
},
"details": {},
"correlationId": "string"
}
}{
"error": {
"code": "string",
"message": "string",
"fields": {
"property1": "string",
"property2": "string"
},
"details": {},
"correlationId": "string"
}
}{
"error": {
"code": "string",
"message": "string",
"fields": {
"property1": "string",
"property2": "string"
},
"details": {},
"correlationId": "string"
}
}{
"error": {
"code": "string",
"message": "string",
"fields": {
"property1": "string",
"property2": "string"
},
"details": {},
"correlationId": "string"
}
}{
"error": {
"code": "string",
"message": "string",
"fields": {
"property1": "string",
"property2": "string"
},
"details": {},
"correlationId": "string"
}
}{
"error": {
"code": "string",
"message": "string",
"fields": {
"property1": "string",
"property2": "string"
},
"details": {},
"correlationId": "string"
}
}{
"error": {
"code": "string",
"message": "string",
"fields": {
"property1": "string",
"property2": "string"
},
"details": {},
"correlationId": "string"
}
}{
"error": {
"code": "string",
"message": "string",
"fields": {
"property1": "string",
"property2": "string"
},
"details": {},
"correlationId": "string"
}
}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
}'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?
Format. Allowed values: csv, json.
ISO 8601 date and time for dateFrom.
ISO 8601 date and time for dateTo.
Status. Allowed values: open, closed, pending.
Unique identifier of the related operator.
Tags assigned to this resource.
Whether to mask recognized personal data in exported text.