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>'
import requests

url = "https://eu-gcp-api.vg-stuff.com/v3/workspaces/{workspaceId}/crawler/jobs"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://eu-gcp-api.vg-stuff.com/v3/workspaces/{workspaceId}/crawler/jobs', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://eu-gcp-api.vg-stuff.com/v3/workspaces/{workspaceId}/crawler/jobs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://eu-gcp-api.vg-stuff.com/v3/workspaces/{workspaceId}/crawler/jobs"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://eu-gcp-api.vg-stuff.com/v3/workspaces/{workspaceId}/crawler/jobs")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://eu-gcp-api.vg-stuff.com/v3/workspaces/{workspaceId}/crawler/jobs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "success": true,
  "message": "<string>",
  "data": {
    "jobs": [
      {
        "id": "<string>",
        "workspaceId": "<string>",
        "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": [],
          "hasSecret": true,
          "hasBearerToken": true,
          "headerKeys": [
            "<string>"
          ]
        }
      }
    ],
    "total": 123,
    "pageSize": 123,
    "hasMore": true,
    "nextCursor": "<string>"
  }
}
{
"message": "<string>",
"code": "<string>",
"issues": [
{
"message": "<string>"
}
]
}

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

cursor
string
limit
integer
Required range: 1 <= x <= 100
includeTotal
boolean
q
string
Maximum string length: 2048

Response

Successful response

success
boolean
required
message
string
required
data
object
required