Skip to main content
GET
List batches
0 credits Requires batches:read permission. See the guide for examples and usage.

Authorizations

Authorization
string
header
required

Send Authorization: Bearer <API_KEY>. Keys have full access unless restricted to scopes.

Query Parameters

limit
integer

Batches per page. Defaults to 25.

Required range: 1 <= x <= 100
cursor
string

Cursor from the previous page.

status
enum<string>

Filter by status.

Available options:
queued,
running,
cancelling,
completed,
cancelled,
failed
q
string

Free-text search term, matched against the batch id, crawl source (start URL or sitemap domain), and tags.

Maximum string length: 200
Example:

"batch_1a2b"

search_type
enum<string>

prefix for as-you-type prefix matching (default), exact for full-token matching.

Available options:
exact,
prefix
tags
string

Comma-separated list of tags to filter by (matches batches having any of them).

Example:

"docs,competitor"

Response

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

request_id
string<uuid>
required

Unique ID of this request, also in X-Request-Id. Include it when contacting support.

Example:

"3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91"

data
Batch · object[]

Batches on this page.

has_more
boolean

Whether another page is available.

next_cursor
string | null

Cursor for the next page.

key_metadata
object

Credits this request used and your remaining balance.