List crawls
Jobs newest first, without their pages.
GET
/v1/crawlsRequest
| Method and path | GET/v1/crawls |
|---|---|
| Base URL | https://api.boxline.dev |
| Authentication | Your API key in the x-api-key header (or Authorization: Bearer). The examples read it from BOXLINE_API_KEY. |
Query parameters
| Name | Type | Default | Allowed values | Description |
|---|---|---|---|---|
limit | integer | 20 | – | From 1 to 100. |
after | string | – | – | The next value of the previous page (same filters and sort). Opaque; do not build it yourself. |
curl "https://api.boxline.dev/v1/crawls?limit=20" \ -H "x-api-key: $BOXLINE_API_KEY"import { Boxline } from "@boxline/sdk";const bx = new Boxline(); // reads BOXLINE_API_KEY and BOXLINE_API_URLconst page = await bx.crawl.list({ limit: 20 });for (const j of page.data) console.log(j.id, j.status, j.pagesDone);from boxline import Boxlinebx = Boxline() # reads BOXLINE_API_KEY and BOXLINE_API_URLpage = bx.crawl.list(limit=20)for job in page.data: print(job["id"], job["status"], job["pagesDone"])Responses
200 OK
A page of jobs.
Fields
| Name | Type | Default | Allowed values | Description |
|---|---|---|---|---|
data | object[] | – | – | |
data[].id | string | – | – | |
data[].status | string | – | running, completed, failed, canceled | |
data[].url | string | – | – | |
data[].params | object | – | – | The crawl's settings (proxy without passwords). |
data[].pagesDone | integer | – | – | |
data[].pagesFailed | integer | – | – | |
data[].skippedByRobots | integer | – | – | |
data[].error | string | null | – | – | |
data[].createdAt | string | – | – | Format: date-time. |
data[].finishedAt | string | null | – | – | Format: date-time. |
data[].data | object[] | – | – | |
data[].data[].index | integer | – | – | |
data[].data[].url | string | – | – | |
data[].data[].finalUrl | string | null | – | – | |
data[].data[].status | integer | null | – | – | |
data[].data[].title | string | null | – | – | |
data[].data[].depth | integer | – | – | |
data[].data[].content | string | null | – | – | |
data[].data[].captcha | string | null | – | recaptcha, hcaptcha, turnstile, cloudflare, datadome, arkose, human | |
data[].data[].error | string | null | – | – | |
data[].next | string | null | – | – | Pass it back as after for the next page; null on the last page. |
next | string | null | – | – | Pass it back as after for the next page; null on the last page. |
{ "data": [ { "id": "crawl_2Gh7Kx0Lq9Zp4Nm3", "status": "running", "url": "https://example.com/", "params": {}, "pagesDone": 0, "pagesFailed": 0, "skippedByRobots": 0, "error": "…", "createdAt": "2026-09-29T10:00:00.000Z", "finishedAt": "2026-09-29T10:00:00.000Z", "data": [ { "index": 0, "url": "https://example.com/", "finalUrl": "https://example.com/", "status": 0, "title": "Example Domain", "depth": 0, "content": "…", "captcha": "recaptcha", "error": "…" } ], "next": "eyJvIjoiY3JlYXRlZF9kZXNjIiwidCI6IjIwMjYtMDktMjlUMTA6MDA6MDAuMTIzNDU2WiIsImkiOiI2YzFmIn0" } ], "next": "eyJvIjoiY3JlYXRlZF9kZXNjIiwidCI6IjIwMjYtMDktMjlUMTA6MDA6MDAuMTIzNDU2WiIsImkiOiI2YzFmIn0"}Errors
Errors have a matching HTTP status and the same body. code is stable, so check it in your code; message is for people. See Errors and request ids.
| Status | Codes | When |
|---|---|---|
| 400 Bad Request | invalid_request, invalid_json, invalid_cursor, invalid_idempotency_key, invalid_extension, variables_with_extensions, terms_not_accepted, invalid_reset_token, invalid_confirmation_code, wrong_password, no_password, invalid_next, invalid_oauth_token | The request is not valid. |
| 401 Unauthorized | unauthorized | Missing or invalid API key. |
{ "error": { "code": "not_found", "message": "session not found", "requestId": "req_4fJx0aQm2Lk9Pz7N" }}Learn more
These docs describe a beta API. Endpoints, fields and SDK methods may change before general availability; breaking changes will be listed in the changelog.