Skip to main content
GET
https://api.getcatalog.ai
/
v2
/
extract
# Get all executions
curl -X GET "https://api.getcatalog.ai/v2/extract" \
  -H "x-api-key: $CATALOG_API_KEY"

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

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

# Get only processing executions with custom page size
curl -X GET "https://api.getcatalog.ai/v2/extract?status=processing&page_size=100" \
  -H "x-api-key: $CATALOG_API_KEY"
{
  "data": [
    {
      "execution_id": "extract-urls-965b1912-6af0-4ed8-b7e3-184b85e788b7",
      "status": "completed",
      "created_at": "2025-01-15T10:30:00.000Z"
    },
    {
      "execution_id": "extract-nike-com-51d87084",
      "status": "running",
      "created_at": "2025-01-15T11:00:00.000Z"
    },
    {
      "execution_id": "extract-adidas-com-660f9511",
      "status": "pending",
      "created_at": "2025-01-15T11:15:00.000Z"
    }
  ],
  "pagination": {
    "page": 1,
    "page_size": 20,
    "total_items": 3,
    "total_pages": 1,
    "has_next": false,
    "has_prev": false
  },
  "meta": {}
}
When to use: Monitor all your extraction operations in one place. Use this endpoint to:
  • See all extraction executions you’ve started
  • Filter by status (processing, completed, failed)
  • Track when extraction jobs 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.Status Values:
  • "processing" - Executions that are currently running or waiting to start (includes pending and running states)
  • "completed" - Executions that finished successfully
  • "failed" - Executions that failed or were aborted
page_size
number
Number of executions to return (minimum: 1, maximum: 100, default: 20)Note: Executions are returned in reverse chronological order (most recent first).

Response

data
array
Array of execution summary objects
pagination
object
Pagination metadata
meta
object
Response metadata (currently empty for this endpoint)
# Get all executions
curl -X GET "https://api.getcatalog.ai/v2/extract" \
  -H "x-api-key: $CATALOG_API_KEY"

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

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

# Get only processing executions with custom page size
curl -X GET "https://api.getcatalog.ai/v2/extract?status=processing&page_size=100" \
  -H "x-api-key: $CATALOG_API_KEY"
{
  "data": [
    {
      "execution_id": "extract-urls-965b1912-6af0-4ed8-b7e3-184b85e788b7",
      "status": "completed",
      "created_at": "2025-01-15T10:30:00.000Z"
    },
    {
      "execution_id": "extract-nike-com-51d87084",
      "status": "running",
      "created_at": "2025-01-15T11:00:00.000Z"
    },
    {
      "execution_id": "extract-adidas-com-660f9511",
      "status": "pending",
      "created_at": "2025-01-15T11:15:00.000Z"
    }
  ],
  "pagination": {
    "page": 1,
    "page_size": 20,
    "total_items": 3,
    "total_pages": 1,
    "has_next": false,
    "has_prev": false
  },
  "meta": {}
}