List Tasks
curl --request GET \
--url https://api.lobstr.io/v1/tasks \
--header 'Authorization: <authorization>'import requests
url = "https://api.lobstr.io/v1/tasks"
headers = {"Authorization": "<authorization>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<authorization>'}};
fetch('https://api.lobstr.io/v1/tasks', 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://api.lobstr.io/v1/tasks",
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: <authorization>"
],
]);
$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://api.lobstr.io/v1/tasks"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<authorization>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.lobstr.io/v1/tasks")
.header("Authorization", "<authorization>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.lobstr.io/v1/tasks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'
response = http.request(request)
puts response.read_body{
"total_results": 123,
"limit": 123,
"page": 123,
"total_pages": 123,
"data": [
{}
],
"data[].id": "<string>",
"data[].created_at": "<string>",
"data[].is_active": true,
"data[].params": {},
"next": {},
"previous": {}
}Task
List Tasks
Retrieve a paginated list of tasks for a specific squid
GET
/
v1
/
tasks
List Tasks
curl --request GET \
--url https://api.lobstr.io/v1/tasks \
--header 'Authorization: <authorization>'import requests
url = "https://api.lobstr.io/v1/tasks"
headers = {"Authorization": "<authorization>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<authorization>'}};
fetch('https://api.lobstr.io/v1/tasks', 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://api.lobstr.io/v1/tasks",
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: <authorization>"
],
]);
$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://api.lobstr.io/v1/tasks"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<authorization>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.lobstr.io/v1/tasks")
.header("Authorization", "<authorization>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.lobstr.io/v1/tasks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'
response = http.request(request)
puts response.read_body{
"total_results": 123,
"limit": 123,
"page": 123,
"total_pages": 123,
"data": [
{}
],
"data[].id": "<string>",
"data[].created_at": "<string>",
"data[].is_active": true,
"data[].params": {},
"next": {},
"previous": {}
}This endpoint retrieves a paginated list of tasks for a specific squid. You can choose between two query types to get different levels of detail.
Headers
string
required
Your API authentication token. Value:
Token YOUR_API_KEYQuery Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| squid | string | Yes | The squid hash ID to list tasks for |
| type | string | No | Filters by how the task was submitted, not a detail level: ‘url’ returns only tasks created with a url field; ‘params’ returns only tasks created with structured parameters instead (e.g. Google Maps Leads Scraper’s city/category/country mode). These are mutually exclusive result sets. Omit type to get all tasks regardless of shape. For crawlers that only ever accept a url (most of them), type=params will always return an empty list — that’s expected, not a bug. |
| page | integer | No | Page number for pagination. Default: 1 |
| limit | integer | No | Results per page. Default: 50, Max: 100 |
Response Field Explanations
integer
Total number of tasks. Example:
2integer
Maximum results per page. Example:
50integer
Current page number. Example:
1integer
Total number of pages. Example:
1array
Array of task objects. Example:
[...]string
Unique task identifier. Example:
"6b9d3afdf4e76df374915a50d7a495c4"string
Task creation timestamp. Example:
"2025-03-05T09:24:49.581177"boolean
Whether the task is active. Example:
trueobject
Task parameters. Example:
{"url": "..."}string | null
URL for next page (null if last page). Example:
nullstring | null
URL for previous page (null if first page). Example:
nullOmit
type unless you specifically need to isolate one task shape — most squids only ever use one or the other, so filtering by type on a URL-only crawler will just return nothing.Results are paginated. Use the next and previous URLs to navigate through large task lists.
Check is_active to identify tasks that are ready to run vs. disabled tasks.
Code Examples
curl -X GET "https://api.lobstr.io/v1/tasks?squid=a1b2c3d4e5f6g7h8i9j0&type=params&page=1&limit=50" \
-H "Authorization: Token YOUR_API_KEY"
import requests
url = "https://api.lobstr.io/v1/tasks"
headers = {
"Authorization": "Token YOUR_API_KEY"
}
params = {
"squid": "a1b2c3d4e5f6g7h8i9j0",
"type": "params", # Only tasks created with structured params, not a url
"page": 1,
"limit": 50
}
response = requests.get(url, headers=headers, params=params)
data = response.json()
print(f"Total tasks: {data['total_results']}")
print(f"Page {data['page']} of {data['total_pages']}\n")
# Display tasks
for task in data['data']:
status = "Active" if task['is_active'] else "Inactive"
print(f"[{status}] Task: {task['id']}")
print(f" Created: {task['created_at']}")
print(f" Params: {task['params']}")
print()
# Check for more pages
if data['next']:
print(f"Next page: {data['next']}")
Response
200
{
"total_results": 2,
"limit": 50,
"page": 1,
"total_pages": 1,
"data": [
{
"id": "6b9d3afdf4e76df374915a50d7a495c4",
"created_at": "2025-03-05T09:24:49.581177",
"is_active": true,
"params": {
"url": "https://www.linkedin.com/in/johndoe"
}
},
{
"id": "c5e29d2aba8b77cdc56391e7405302de",
"created_at": "2025-03-05T09:24:49.581177",
"is_active": true,
"params": {
"url": "https://www.linkedin.com/in/janedoe"
}
}
],
"next": null,
"previous": null
}