---
title: "Retrieve a Batch Job"
method: GET
path: "/batch-jobs/{batch-job-id}"
tags: ["importers"]
---

# Retrieve a Batch Job

`GET /batch-jobs/{batch-job-id}`

## Request

- Base URL: `https://api.withpersona.com/api/v1`
- URL: `https://api.withpersona.com/api/v1/batch-jobs/{batch-job-id}`
- Auth: HTTP bearer

Retrieve the status and counts for an existing Batch Job.

## Path parameters

- `batch-job-id` string, required

## Query parameters

- `include` string
- `fields` object

## Headers

- `Key-Inflection` 'camel' | 'kebab' | 'snake'
- `Persona-Version` '2026-09-29' | '2025-12-08' | '2025-10-27' | '2023-01-05' | '2022-09-01' | '2021-08-18' | '2021-07-05' | '2021-02-21' | '2020-05-18': Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).

## Response `200`

This endpoint returns a Batch Job resource.

- ImportersRetrieveABatchJobResponse200
  - `data` BatchJob, required: A Batch Job object.
    - `type` 'batch-job'
    - `id` string
    - `attributes` BatchJobAttributes
      - `status` string: Current status of the batch job. Possible values include `pending`, `running`, `paused`, `canceled`, `completed`, `errored`, and `killed`.
      - `run-count` integer: Number of times this batch job has been executed
      - `started-at` string, date-time, nullable: When the batch job started processing
      - `ended-at` string, date-time, nullable: When the batch job finished processing
      - `created-at` string, date-time: When the batch job was created
      - `updated-at` string, date-time: When the batch job was last updated
      - `redacted-at` string, date-time, nullable: When the batch job was redacted
      - `run-data` BatchJobAttributesRunData: Runtime data and statistics for the batch job
        - `column-names` string[]: Names of columns being processed
        - `error-count` integer: Number of errors encountered
        - `rows-read` integer: Number of rows read from the source
        - `row-count` integer: Total number of rows processed
        - `success-count` integer: Number of rows successfully processed
        - `created-count` integer: Number of new records created
        - `updated-count` integer: Number of existing records updated

## Other responses

- `400`: The request was unacceptable, often due to invalid parameters.
- `401`: An invalid API key was provided.
- `403`: The given API key doesn’t have permissions to perform the request or a quota has been exceeded.
- `404`: The requested resource doesn’t exist.
- `429`: Your organization’s rate limit has been exceeded. We recommend an exponential backoff on requests.

---

[API](https://skmtc.dev/withpersona/apis/withpersona-8.md) - [All operations](https://skmtc.dev/withpersona/apis/withpersona-8/llms.txt) - [OpenAPI document](https://skmtc.dev/withpersona/apis/withpersona-8/revisions/3683a7f9e1fe?raw)