---
title: "Get an export batch"
method: GET
path: "/api/v1/export-batches/{batch_id}"
tags: ["Exports"]
---

# Get an export batch

`GET /api/v1/export-batches/{batch_id}`

## Request

- Base URL: `https://app.argorant.com`
- URL: `https://app.argorant.com/api/v1/export-batches/{batch_id}`
- Auth: HTTP bearer

An export above 50,000 rows runs as a batch of files. This shows each file with its status and download path.

| Cost | What it does | Key scopes |
| --- | --- | --- |
| Free | Reads only | `argorant:create_exports` |

## Path parameters

- `batch_id` integer, required

## Headers

- `X-Request-Id` string

## Response `200`

OK

- ExportBatch
  - `batch_id` integer: Batch id.
  - `status` string: Where the batch is.
  - `requested_rows` integer: Rows asked for.
  - `chunk_size` integer: Rows per file.
  - `total_chunks` integer: Number of files.
  - `chunks` Export[]: One export per file, each with job_id, status and download_url.
    - `job_id` integer: Export id.
    - `name` string, nullable: Your name for the file.
    - `status` 'queued' | 'processing' | 'done' | 'failed' | 'cancelled': Where the export is.
    - `progress_pct` integer, nullable: Percent done.
    - `limit` integer, nullable: Rows asked for.
    - `total_rows` integer, nullable: Rows in the file.
    - `verified_rows` integer, nullable: Rows whose email passed the check.
    - `no_email_rows` integer, nullable: Rows without an email.
    - `grade_counts` object, nullable: How many rows got each check result.
    - `downloadable` boolean: true when the CSV can be downloaded.
    - `include_phones` boolean: Whether phone numbers were asked for.
    - `exclude_previously_exported` boolean: Whether people exported before were left out.
    - `credits_charged` integer, nullable: Credits charged for this file.
    - `emails_billed` integer, nullable: Emails charged.
    - `phones_billed` integer, nullable: Phone numbers charged.
    - `error_message` string, nullable: Why it failed, in plain words.
    - `billing_note` string, nullable: How the file was charged, in one plain sentence.
    - `batch_id` integer, nullable: The batch this file belongs to, for exports above 50,000 rows.
    - `chunk_index` integer, nullable: Its place in the batch.
    - `filters` object: The filters of the export.
    - `created_at` string, date-time, nullable: When it was created.
    - `started_at` string, date-time, nullable: When it started.
    - `completed_at` string, date-time, nullable: When it finished.
    - `status_url` string, nullable: Path to check the export.
    - `download_url` string, nullable: Path of the CSV download once done.

## Other responses

- `401`: 401 Unauthorized. `unauthorized` when the API key is missing, wrong or revoked.
- `403`: 403 Forbidden. `scope_missing` when the key lacks argorant:create_exports.
- `404`: 404 Not found. `not_found` when the item does not exist in your workspace.
- `429`: 429 Too many requests. `rate_limited` when too many requests this minute.

---

[API](https://skmtc.dev/argorant/apis/argorant-api.md) · [All operations](https://skmtc.dev/argorant/apis/argorant-api/llms.txt) · [OpenAPI document](https://skmtc.dev/argorant/apis/argorant-api/revisions/4bc28c0085b6?raw)