Get Task
Retrieve detailed information about a specific task
https://api.lobstr.io/v1/tasks/{task_hash}This endpoint retrieves detailed information about a specific task using its hash ID, including its current status, parameters, and execution history.
Headers
AuthorizationstringheaderrequiredYour API authentication token. Value: Token YOUR_API_KEY
Path Parameters
task_hashstringpathrequiredThe unique identifier (hash) of the task. Example: c5e29d2aba8b77cdc56391e7405302de
Response Field Explanations
hash_valuestringUnique task identifier. Example: "c5e29d2aba8b77cdc56391e7405302de"
created_atstringTask creation timestamp (ISO 8601). Example: "2024-12-24T10:57:55.045567"
is_activebooleanWhether the task is active. Example: true
paramsobjectTask parameters (URL, search terms, etc.). Example: {"url": "https://..."}
moduleintegerInternal module identifier. Example: 5
statusobjectDetailed execution status information. Example: {...}
objectstringAlways "task". Example: "task"
Status Object Fields
status.statusstringCurrent task status (pending, running, completed, aborted, failed). Example: "completed"
status.started_atstringWhen task execution started. Example: "2025-02-04T10:25:47.278419"
status.ended_atstringWhen task execution ended. Example: "2025-02-04T10:26:52.310738"
status.is_donebooleanWhether the task has completed. Example: true
status.total_resultsintegerTotal number of results scraped. Example: 156
status.total_pagesintegerTotal pages processed. Example: 1
status.done_reasonstringReason for task completion (completed, run_aborted, error, etc.). Example: "completed"
status.has_errorsbooleanWhether errors occurred during execution. Example: false
status.errorsstring | nullError 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
{ "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" }
{ "error": { "message": "Task not found", "type": "not_found_error", "param": "task_hash" } }