List Crawls

List all crawls with status. Shows all crawl jobs, their current status, and when they were created.

GET /v2/crawl

cURL

PowerShell

# Get all executions
curl -X GET "https://api.getcatalog.ai/v2/crawl" \
  -H "x-api-key: $CATALOG_API_KEY"

# Get only completed executions
curl -X GET "https://api.getcatalog.ai/v2/crawl?status=completed" \
  -H "x-api-key: $CATALOG_API_KEY"

# Get first 50 executions
curl -X GET "https://api.getcatalog.ai/v2/crawl?page_size=50" \
  -H "x-api-key: $CATALOG_API_KEY"

Success Response

{
  "data": [
    {
      "execution_id": "crawl-skims-com-4ddfa1c9",
      "status": "processing",
      "created_at": "2026-01-09T23:45:35.570072+00:00"
    }
  ],
  "pagination": {
    "page": 1,
    "page_size": 20,
    "total_items": 1,
    "total_pages": 1,
    "has_next": false,
    "has_prev": false
  },
  "meta": {}
}

When to use: Monitor all your crawl operations in one place. Use this endpoint to:

• See all crawl executions you’ve started
• Filter by status (processing, completed, failed)
• Track when crawls were initiated
• Find execution IDs for status checks

Request

x-api-key · string · required

Your API key for authentication

Query Parameters

status · string

Filter executions by status. Possible values: "processing", "completed", "failed"

Note: If not provided, all executions are returned regardless of status.

page_size · number

Number of executions to return per page (default: 20)

Note: Executions are returned in reverse chronological order (most recent first).

Response

data · array

Array of execution summary objects

Show Execution Summary

execution_id · string

Unique execution identifier. Use this ID with GET /v2/crawl/{execution_id} to check detailed status and results.

Format: crawl-{hostname}-{uuid}

status · string

Current execution status

Possible values:

• "processing" - Execution is currently running
• "completed" - Execution finished successfully
• "failed" - Execution failed or was aborted

created_at · string

ISO 8601 timestamp when the execution was created

pagination · object

Pagination information for the response

Show Pagination Object

page · number

Current page number (always 1 for this endpoint)

page_size · number

Number of items per page

total_items · number

Total number of executions returned (may be less than or equal to page_size)

total_pages · number

Total number of pages (always 1 for this endpoint)

has_next · boolean

Whether there are more pages available (always false for this endpoint)

has_prev · boolean

Whether there are previous pages available (always false for this endpoint)

meta · object

Metadata object (currently empty for this endpoint)

cURL

PowerShell

# Get all executions
curl -X GET "https://api.getcatalog.ai/v2/crawl" \
  -H "x-api-key: $CATALOG_API_KEY"

# Get only completed executions
curl -X GET "https://api.getcatalog.ai/v2/crawl?status=completed" \
  -H "x-api-key: $CATALOG_API_KEY"

# Get first 50 executions
curl -X GET "https://api.getcatalog.ai/v2/crawl?page_size=50" \
  -H "x-api-key: $CATALOG_API_KEY"

Success Response

{
  "data": [
    {
      "execution_id": "crawl-skims-com-4ddfa1c9",
      "status": "processing",
      "created_at": "2026-01-09T23:45:35.570072+00:00"
    }
  ],
  "pagination": {
    "page": 1,
    "page_size": 20,
    "total_items": 1,
    "total_pages": 1,
    "has_next": false,
    "has_prev": false
  },
  "meta": {}
}