Skip to main content
GET
JavaScript
0 Credits

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <API_KEY>, where <API_KEY> is your api key.

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.

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

Metadata about the API key used for the request. Included in every response whenever a valid API key is provided, even when the response status is not 200.