---
title: "List batches"
method: GET
path: "/batch/list"
tags: ["Batches"]
---

# List batches

`GET /batch/list`

## Request

- Base URL: `https://api.context.dev/v1`
- URL: `https://api.context.dev/v1/batch/list`
- Auth: HTTP bearer

List your batches, newest first, with optional filters.

## Query parameters

- `shouldIncludeUnified` boolean: Include batches submitted with Scrape Anything formats. Defaults to false.
- `limit` integer: Batches per page. Defaults to 25.
- `cursor` string: Cursor from the previous page.
- `status` 'queued' | 'running' | 'cancelling' | 'completed' | 'cancelled' | 'failed': Filter by status.
- `q` string: Free-text search term, matched against the batch id, crawl source (start URL or sitemap domain), and tags.
- `search_type` 'exact' | 'prefix': `prefix` for as-you-type prefix matching (default), `exact` for full-token matching.
- `tags` union: Tags to filter by (matches batches having any of them). Pass repeated `tags` params or one comma-separated list, e.g. `tags=docs,competitor`.
  - string
  - string[]

## Response `200`

Your batches, newest first. Use `next_cursor` to page through the rest.

- object
  - `data` Batch[]: Batches on this page. (unresolved $ref)
  - `has_more` boolean: Whether another page is available.
  - `next_cursor` string, nullable: Cursor for the next page.
  - `key_metadata` KeyMetadata: Credits this request used and your remaining balance.
    - `credits_consumed` integer, required: Credits charged for this request.
    - `credits_remaining` integer, required: Credits remaining for your organization.
  - `request_id` string, uuid, required: Unique ID of this request, also in `X-Request-Id`. Include it when contacting support.

## Other responses

- `400`: Bad request
- `401`: Unauthorized
- `403`: API key permissions or organization settings do not allow this request.
- `429`: Rate limit exceeded. Organization concurrency rejections include structured error_data and subscription settings; follow Retry-After before retrying.
- `503`: Search is temporarily unavailable (`SEARCH_UNAVAILABLE`). Retry or list without search filters.

## Changes

- **2026-10-21** `61627728926b`: 4 warning, 1 info
  - added the new `NO_PUBLISHED_MARKDOWN` enum value to the `error_code` response property for the response status `400`
  - added the new `NO_PUBLISHED_MARKDOWN` enum value to the `error_code` response property for the response status `401`
  - added the new `NO_PUBLISHED_MARKDOWN` enum value to the `error_code` response property for the response status `403`
  - added the new `NO_PUBLISHED_MARKDOWN` enum value to the `error_code` response property for the response status `503`
  - …1 more
- **2026-10-19** `aeb64a2b7925`: 1 info
  - added the required property `data/items/crawl/anyOf[subschema #1]/allOf[subschema #1: Crawl controls]/exclude_url_pattern` to the response with the `200` status
- **2026-10-19** `4ddcf49b9fe5`: 5 info
  - added the optional property `error_data` to the response with the `400` status
  - added the optional property `error_data` to the response with the `401` status
  - added the optional property `error_data` to the response with the `403` status
  - added the optional property `error_data` to the response with the `429` status
  - …1 more
- **2026-10-16** `2125f3e94e52`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/context/apis/brand-api/changes/batch/list/get.md)

---

[API](https://skmtc.dev/context/apis/brand-api.md) · [All operations](https://skmtc.dev/context/apis/brand-api/llms.txt) · [OpenAPI document](https://skmtc.dev/context/apis/brand-api/revisions/9e2ab7841fb1?raw)