Data Exporter

List Batch data exports

get/data-exporter/batch

Request

  • Base URL: https://api.carbonvoice.app
  • URL: https://api.carbonvoice.app/data-exporter/batch
  • Auth: none declared

Query parameters

workspace_idstring
Example:workspace_123

Filter data exports by workspace ID

Response

batch_idstring required

Batch identifier of the export job

creator_idstring required

Identifier of the user that requested the export

workspace_idstring required

Workspace associated with the batch export

created_atstring date-time required

Creation timestamp of the batch export

start_datestring date-time

Start date filter applied to the export (if any)

end_datestring date-time

End date filter applied to the export (if any)

expires_atstring date-time

Expiration date for the batch export download (if any)

status'created' | 'in_progress' | 'compressing_and_uploading' | 'completed' | 'partially_failed' | 'failed' required

Export status for the batch

has_errorsboolean required

Indicates whether any export in the batch encountered errors

Example response

[
  {
    "batch_id": "RLYuYKTGtKsM1dEf",
    "creator_id": "SIIRnfNwKgIqwp77",
    "workspace_id": "6OXcPH0Nfwy66W6o",
    "created_at": "2025-11-07T14:29:40.970Z",
    "start_date": "2025-11-01T00:00:00.000Z",
    "end_date": "2025-11-07T23:59:59.000Z",
    "expires_at": "2025-11-08T14:29:45.556Z",
    "status": "completed",
    "total_records": {
      "total_channels": 1,
      "total_messages": 3
    }
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.