---
title: "List Batch data exports"
method: GET
path: "/data-exporter/batch"
tags: ["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_id` string

## Response `200`

- BatchExport[]
  - `batch_id` string, required: Batch identifier of the export job
  - `creator_id` string, required: Identifier of the user that requested the export
  - `workspace_id` string, required: Workspace associated with the batch export
  - `created_at` string, date-time, required: Creation timestamp of the batch export
  - `start_date` string, date-time: Start date filter applied to the export (if any)
  - `end_date` string, date-time: End date filter applied to the export (if any)
  - `expires_at` string, 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_errors` boolean, required: Indicates whether any export in the batch encountered errors
  - `total_records` BatchTotalRecords, required
    - `total_users` number, required: Total number of users included in the batch export
    - `total_channels` number, required: Total number of channels included in the batch export
    - `total_messages` number, required: Total number of messages included in the batch export

## Other responses

- `401`: Unauthorized

---

[API](https://skmtc.dev/carbonvoice/apis/carbon-voice-api.md) · [All operations](https://skmtc.dev/carbonvoice/apis/carbon-voice-api/llms.txt) · [OpenAPI document](https://skmtc.dev/carbonvoice/apis/carbon-voice-api/revisions/b91c5c845122?raw)