Skip to main content
GET
/
v1
/
tasks
/
{task_hash}
Get Task
curl --request GET \
  --url https://api.lobstr.io/v1/tasks/{task_hash} \
  --header 'Authorization: <authorization>'
{
  "hash_value": "<string>",
  "created_at": "<string>",
  "is_active": true,
  "params": {},
  "module": 123,
  "status": {},
  "object": "<string>",
  "status.status": "<string>",
  "status.started_at": "<string>",
  "status.ended_at": "<string>",
  "status.is_done": true,
  "status.total_results": 123,
  "status.total_pages": 123,
  "status.done_reason": "<string>",
  "status.has_errors": true,
  "status.errors": {}
}

Documentation Index

Fetch the complete documentation index at: https://docs.lobstr.io/llms.txt

Use this file to discover all available pages before exploring further.

This endpoint retrieves detailed information about a specific task using its hash ID, including its current status, parameters, and execution history.

​
Headers

​
Authorization
string
required
Your API authentication token. Value: Token YOUR_API_KEY

​
Query Parameters

​
task_hash
string
required
The unique identifier (hash) of the task. Example: c5e29d2aba8b77cdc56391e7405302de

​
Response Field Explanations

​
hash_value
string
Unique task identifier. Example: "c5e29d2aba8b77cdc56391e7405302de"
​
created_at
string
Task creation timestamp (ISO 8601). Example: "2024-12-24T10:57:55.045567"
​
is_active
boolean
Whether the task is active. Example: true
​
params
object
Task parameters (URL, search terms, etc.). Example: {"url": "https://..."}
​
module
integer
Internal module identifier. Example: 5
​
status
object
Detailed execution status information. Example: {...}
​
object
string
Always “task”. Example: "task"

​
Status Object Fields

​
status.status
string
Current task status (pending, running, completed, aborted, failed). Example: "completed"
​
status.started_at
string
When task execution started. Example: "2025-02-04T10:25:47.278419"
​
status.ended_at
string
When task execution ended. Example: "2025-02-04T10:26:52.310738"
​
status.is_done
boolean
Whether the task has completed. Example: true
​
status.total_results
integer
Total number of results scraped. Example: 156
​
status.total_pages
integer
Total pages processed. Example: 1
​
status.done_reason
string
Reason for task completion (completed, run_aborted, error, etc.). Example: "completed"
​
status.has_errors
boolean
Whether errors occurred during execution. Example: false
​
status.errors
string | null
Error details if any occurred. Example: null
Use the status.total_results field to track how much data has been collected for this task.
The done_reason field helps identify why a task stopped - whether it completed normally, was aborted, or encountered errors.
Tasks with status ‘aborted’ may have partial results. Check total_results to see what was collected.

​
Code Examples

curl -X GET "https://api.lobstr.io/v1/tasks/c5e29d2aba8b77cdc56391e7405302de" \
  -H "Authorization: Token YOUR_API_KEY"

​
Response

200
{
  "hash_value": "c5e29d2aba8b77cdc56391e7405302de",
  "created_at": "2024-12-24T10:57:55.045567",
  "is_active": true,
  "params": {
    "url": "https://www.linkedin.com/in/johndoe"
  },
  "module": 5,
  "status": {
    "status": "completed",
    "started_at": "2025-02-04T10:25:47.278419",
    "ended_at": "2025-02-04T10:26:52.310738",
    "is_done": true,
    "total_results": 156,
    "total_pages": 1,
    "done_reason": "completed",
    "has_errors": false,
    "errors": null
  },
  "object": "task"
}
404
{
  "error": {
    "message": "Task not found",
    "type": "not_found_error",
    "param": "task_hash"
  }
}