Skip to main content
GET
/
v1
/
crawl
List Crawls
curl --request GET \
  --url https://sdk.nimbleway.com/v1/crawl \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "url": "<string>",
      "status": "pending",
      "total": 123,
      "completed": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "completed_at": "2023-11-07T05:31:56Z",
      "crawl_options": {},
      "extract_options": {},
      "tasks": [
        {}
      ]
    }
  ],
  "pagination": {
    "hasNext": true,
    "nextCursor": "<string>",
    "total": 123
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

status
enum<string>
required

Filter crawls by their status

Available options:
pending,
in_progress,
completed,
failed,
canceled
Example:

"pending"

cursor
null | string

Cursor for pagination

limit
integer

Number of crawls to return per page

Required range: 1 <= x <= 9007199254740991
Example:

10

Response

Successful Response - List of Crawl Tasks

data
object[]
required

Array of crawl tasks

pagination
object
required

Pagination information