List batch jobs
Lists this API key's project's jobs, newest first (`submitted_at` desc, then id desc).
Requires scope: batch
Lists this API key's project's jobs, newest first (submitted_at desc, then id desc). Jobs of other
projects in the organization are not visible to this key. Each entry is the full job object with progress.
To page, pass next_cursor back as cursor; when next_cursor is absent there are no more jobs.
Authorization
bearerAuth Authorization: Bearer <key>. Read the key from the SPICRAWL_API_KEY environment
variable; never hard-code or log it. spicrawl_test_… keys can never spend live
credits. Scopes: scrape, batch, sessions (granted by default), browser
and read (granted deliberately). A missing scope is 403 ERR::AUTH::INSUFFICIENT_SCOPE naming the scope.
In: header
Query Parameters
Jobs per page. Out-of-range or non-integer values are a 400, not clamped.
1 <= value <= 20050Return only jobs whose stored status equals this value (case-insensitive). Omit for all statuses.
Value in
- "queued"
- "running"
- "paused"
- "cancelling"
- "completed"
- "failed"
- "cancelled"
Opaque token from a previous page's next_cursor. Pass it back verbatim; do not construct it. Omit to start from the newest job.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X GET "https://example.com/v1/batch"{ "batches": [ { "id": "01J9Z6T3W9E21T5TZARVJRVN5C", "project_id": "01J8X2M4C7Q1H5V9P3R6T8W0YB", "name": "catalog-2026-09-22", "status": "running", "status_url": "/v1/batch/01J9Z6T3W9E21T5TZARVJRVN5C", "results_url": "/v1/batch/01J9Z6T3W9E21T5TZARVJRVN5C/results", "params": { "js_render": true, "proxy_country": "us", "credit_budget_micro": 8000000 }, "total_items": 2, "concurrency": 20, "priority": 100, "max_attempts": 3, "estimated_credits": 8, "estimated_credits_micro": 8000000, "progress": { "total": 2, "completed": 1, "succeeded": 1, "failed": 0, "cancelled": 0, "skipped": 0, "remaining": 1, "percent_complete": 50, "credits_charged": 4, "credits_charged_micro": 4000000, "bytes": 326000 }, "submitted_at": "2026-09-22T06:41:12Z", "started_at": "2026-09-22T06:41:13Z", "results_expire_at": "2026-09-25T06:41:12Z" } ], "next_cursor": "string"}