---
title: "List your organization's batches."
method: GET
path: "/batches"
tags: ["Batch"]
---

# List your organization's batches.

`GET /batches`

## Request

- Base URL: `https://gateway.obiguard.ai/v1`
- URL: `https://gateway.obiguard.ai/v1/batches`
- Auth: none declared

## Query parameters

- `after` string
- `limit` integer

## Response `200`

Batch listed successfully.

- ListBatchesResponse
  - `data` Batch[], required
    - `id` string, required
    - `object` 'batch', required: The object type, which is always `batch`.
    - `endpoint` string, required: The Obiguard API endpoint used by the batch.
    - `errors` object
      - `object` string: The object type, which is always `list`.
      - `data` object[]
        - `code` string: An error code identifying the error type.
        - `message` string: A human-readable message providing more details about the error.
        - `param` string, nullable: The name of the parameter that caused the error, if applicable.
        - `line` integer, nullable: The line number of the input file where the error occurred, if applicable.
    - `input_file_id` string, required: The ID of the input file for the batch.
    - `completion_window` string, required: The time frame within which the batch should be processed.
    - `status` 'validating' | 'failed' | 'in_progress' | 'finalizing' | 'completed' | 'expired' | 'cancelling' | 'cancelled', required: The current status of the batch.
    - `output_file_id` string: The ID of the file containing the outputs of successfully executed requests.
    - `error_file_id` string: The ID of the file containing the outputs of requests with errors.
    - `created_at` integer, required: The Unix timestamp (in seconds) for when the batch was created.
    - `in_progress_at` integer: The Unix timestamp (in seconds) for when the batch started processing.
    - `expires_at` integer: The Unix timestamp (in seconds) for when the batch will expire.
    - `finalizing_at` integer: The Unix timestamp (in seconds) for when the batch started finalizing.
    - `completed_at` integer: The Unix timestamp (in seconds) for when the batch was completed.
    - `failed_at` integer: The Unix timestamp (in seconds) for when the batch failed.
    - `expired_at` integer: The Unix timestamp (in seconds) for when the batch expired.
    - `cancelling_at` integer: The Unix timestamp (in seconds) for when the batch started cancelling.
    - `cancelled_at` integer: The Unix timestamp (in seconds) for when the batch was cancelled.
    - `request_counts` object: The request counts for different statuses within the batch.
      - `total` integer, required: Total number of requests in the batch.
      - `completed` integer, required: Number of requests that have been completed successfully.
      - `failed` integer, required: Number of requests that have failed.
    - `metadata` object, nullable: Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maxium of 512 characters long.
  - `first_id` string
  - `last_id` string
  - `has_more` boolean, required
  - `object` 'list', required

---

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