Skip to main content
GET
/
workspaces
/
{workspaceId}
/
crawler
/
jobs
List crawler jobs
curl --request GET \
  --url https://eu-gcp-api.vg-stuff.com/v3/workspaces/{workspaceId}/crawler/jobs \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "message": "<string>",
  "data": {
    "jobs": [
      {
        "id": "<string>",
        "workspaceId": "<string>",
        "status": "queued",
        "primaryUrl": "<string>",
        "urls": [
          "<string>"
        ],
        "crawl": true,
        "crawlOptions": {
          "maxPages": 250,
          "urlMatchers": [
            "<string>"
          ],
          "unMatchers": [
            "<string>"
          ],
          "stayOnDomain": true
        },
        "useProxy": true,
        "deep": true,
        "refreshRate": "<string>",
        "toAgentId": "<string>",
        "toAgentIds": [
          "<string>"
        ],
        "done": true,
        "failed": true,
        "isCancelled": true,
        "message": "<string>",
        "resultError": "<string>",
        "createdAt": "<string>",
        "ts": 123,
        "currentPageIndex": 123,
        "scrapedPagesNum": 123,
        "failedPagesNum": 123,
        "pageLimit": 123,
        "creditsPerPage": 123,
        "estimatedCredits": 123,
        "activeScrapeUrl": "<string>",
        "crawlerJobId": "<string>",
        "webhook": {
          "url": "<string>",
          "events": [
            "page_scraped"
          ],
          "hasSecret": true,
          "hasBearerToken": true,
          "headerKeys": [
            "<string>"
          ]
        }
      }
    ],
    "total": 123,
    "page": 123,
    "pageSize": 123
  }
}

Overview

Returns paginated crawler jobs for the selected workspace.

Includes

  • Job status
  • Page counts
  • Estimated credits
  • Per-page billing rate
  • Webhook summary configuration
Use the page and limit query parameters to paginate through large job histories.

Authorizations

Authorization
string
header
required

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

Path Parameters

workspaceId
string
required

Query Parameters

page
integer
Required range: x >= 1
limit
integer
Required range: 1 <= x <= 100

Response

Successful response

success
boolean
required
message
string
required
data
object
required