---
title: "Crawl by Filter"
method: GET
path: "/v1/crawl"
tags: ["Crawl"]
---

# Crawl by Filter

`GET /v1/crawl`

## Query parameters

- `status` 'queued' | 'running' | 'succeeded' | 'failed' | 'canceled' | 'all' — Filter crawls by their status.
- `cursor` string, nullable — Cursor for pagination.
- `limit` integer — Number of crawls to return per page.

## Response `200`

Successful Response - List of Crawl Tasks

- CrawlByFiltersResponse — Successful get crawl response
  - `data` CrawlApiResponse[], required
    - `account_name` string, required
    - `completed` number
    - `completed_at` union
      - string
      - object
    - `crawl_id` string, uuid, required
    - `crawl_options` object, required
      - `allow_external_links` boolean, required
      - `allow_subdomains` boolean, required
      - `callback` union
        - object
          - `events` string[]
          - `headers` object
          - `metadata` object
          - `url` string, uri, required
        - string, uri
      - `crawl_entire_domain` boolean, required
      - `exclude_paths` string[]
      - `ignore_query_parameters` boolean, required
      - `include_paths` string[]
      - `limit` integer, required
      - `max_discovery_depth` integer, required
      - `sitemap` 'skip' | 'include' | 'only', required
    - `created_at` union, required
      - string
      - object
    - `extract_options` object, nullable
    - `failed` number
    - `name` string, nullable
    - `pending` number
    - `status` 'queued' | 'running' | 'succeeded' | 'failed' | 'canceled', required
    - `tasks` object[]
      - `created_at` string
      - `status` 'pending' | 'completed' | 'failed', required
      - `task_id` string, required
      - `updated_at` string
    - `total` number
    - `updated_at` union, required
      - string
      - object
    - `url` string, uri, required
  - `pagination` object, required
    - `has_next` boolean, required
    - `next_cursor` string, nullable
    - `total` number

---

[API](https://skmtc.net/nimbleway/apis/api-gateway.md) · [All operations](https://skmtc.net/nimbleway/apis/api-gateway/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/nimbleway/api-gateway/revisions/9bfe220b7a29/schema)