---
title: "Gets all batches."
method: GET
path: "/address/bulk/v1/batches"
tags: ["Bulk Address"]
---

# Gets all batches.

`GET /address/bulk/v1/batches`

## Request

- Base URL: `https://api.experianaperture.io`
- URL: `https://api.experianaperture.io/address/bulk/v1/batches`
- Auth: one of:
  - HTTP bearer
  - API key in header `Auth-Token`
- TypeScript: <https://skmtc.dev/experianaperture/apis/aperture-rest-api/docs/address/bulk/v1/batches/get.ts> (a function with typed inputs; its response is checked against the schema)

## Headers

- `Reference-Id` string

## Response `200`

OK

- BulkAddressV1GetBatchesResponse: Bulk Address V1 Get Batches response.
  - `error` ResponseError: Error model containing the error details.
    - `type` string, nullable: A link to documentation that provides more details about the error you’ve encountered.
    - `title` string, nullable: The title of the error.
    - `detail` string, nullable: A description of the error.
    - `instance` string, nullable: The endpoint that returned the error.
  - `result` BulkAddressV1GetBatchesResult: Bulk Address V1 Get Batches result.
    - `batches` BulkAddressV1GetBatchesBatch[], nullable: Batches.
      - `batch_id` string, nullable: Batch ID.
      - `batch_reference_id` string, nullable: Optional reference identifier to track this batch.
      - `status` string, nullable: The current Batch status.
      - `reason` string, nullable: The reason of the current Batch status.
      - `records` integer: The number of addresses have been submitted.
      - `records_processed` integer: The number of addresses have been processed.
      - `date_submitted` string, date-time: The date time when the Batch is created in ISO-8601 format.
      - `date_started` string, date-time, nullable: The date time when the Batch is started in ISO-8601 format.
      - `date_ended` string, date-time, nullable: The date time when the Batch is ended in ISO-8601 format.

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `406`: Not Acceptable
- `408`: Request Timeout
- `429`: Too Many Requests
- `500`: Internal Server Error
- `503`: Service Unavailable

---

[API](https://skmtc.dev/experianaperture/apis/aperture-rest-api.md) - [All operations](https://skmtc.dev/experianaperture/apis/aperture-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/experianaperture/apis/aperture-rest-api/revisions/e762934f3de5?raw)