---
title: "Get batch data export"
method: GET
path: "/data-exporter/batch/{id}"
tags: ["Data Exporter"]
---

# Get batch data export

`GET /data-exporter/batch/{id}`

## Request

- Base URL: `https://api.carbonvoice.app`
- URL: `https://api.carbonvoice.app/data-exporter/batch/{id}`
- Auth: none declared

## Path parameters

- `id` string, required

## Response `200`

- ExportBatchDataResponse
  - `total_batches` number, required: Total Batches
  - `total_users` number, required: Total Users
  - `total_channels` number, required: Total Channels
  - `total_messages` number, required: Total Messages
  - `batch_exports` ExportDataResponse[], required: List of data exporters
    - `id` string, required: Id of the export
    - `status` string, required: Status of the export
    - `creator_id` string, required: Creator ID
    - `user_ids` string[]: User IDs
    - `conversation_ids` string[]: Conversation IDs
    - `workspace_id` string, required: Workspace ID
    - `download_url` string, required: Signed URL of the export data
    - `created_at` string, date-time, required: Created at
    - `last_updated_at` string, date-time, required: Last updated at
    - `expires_at` string, date-time: Expired at
    - `start_date` string, date-time: Filter for start date
    - `end_date` string, date-time: Filter for end date
    - `completion_percentage` CompletionPercentage, required
      - `users` number, required: Completion percentage for users
      - `conversations` number, required: Completion percentage for conversations
      - `messages` number, required: Completion percentage for messages
    - `completion_status` CompletionStatus, required
      - `users` boolean, required: Completion status for users
      - `conversations` boolean, required: Completion status for conversations
      - `messages` boolean, required: Completion status for messages
    - `total_records_to_export` TotalRecordsToExport, required
      - `users` number, required: Total records to export for users
      - `conversations` number, required: Total records to export for conversations
      - `messages` number, required: Total records to export for messages
    - `export_errors` string[]: List of errors that occurred during processing
    - `batch_id` string: Batch ID (Used when exporting multiple users that have multiple channels)
  - `batch_id` string: Batch ID (Used when exporting multiple users that have multiple channels)

## Other responses

- `401`: Unauthorized
- `404`

---

[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)