Skip to main content
GET
/
v2
/
tasks
/
{task_id}
Get Task Status
curl --request GET \
  --url https://api.hirebase.org/v2/tasks/{task_id}
{
  "id": "<string>",
  "type": "<string>",
  "state": "<string>",
  "progress": 123,
  "created_at": "<string>",
  "updated_at": "<string>",
  "started_at": "<string>",
  "completed_at": "<string>",
  "user_id": "<string>",
  "error": "<string>",
  "worker_id": "<string>",
  "priority": 123,
  "input": {
    "query": {},
    "format": "<string>"
  },
  "result": {
    "download_url": "<string>",
    "file_size": 123,
    "record_count": 123,
    "expiry_time": "<string>"
  }
}
Check the status, progress, and output of an asynchronous task by providing its unique task ID. Tasks may take anywhere from a few seconds to several hours to complete, depending on the size of the request.

​
Endpoint

GET  /v2/tasks/{task_id}

​
Path Parameters

​
task_id
string
required
The UUID of the task to query

​
Response

​
id
string
Unique identifier of the task
​
type
string
Type of the task (e.g., “export_job_data”)
​
state
string
Current state of the task such as:
  • Queued: Task has been accepted and is waiting to be processed
  • Processing: Task is currently being executed asynchronously by a worker
  • Finished: Task has completed successfully, and the result is available
  • Failed: Task execution failed; error details are available in the error field. Contact support with your task ID if needed.
  • Canceled: Cancellation is not supported yet but may be in future for select items
​
progress
number
Task progress as a float between 0.0 and 1.0
​
created_at
string
ISO timestamp of when the task was created
​
updated_at
string
ISO timestamp of the last task update
​
started_at
string
ISO timestamp of when the task began processing
​
completed_at
string
ISO timestamp of when the task finished processing
​
user_id
string
ID of the user who initiated the task
​
error
string
Error message if the task failed, otherwise null
​
worker_id
string
ID of the worker node that processed the task
​
priority
integer
Priority level of the task (higher means more urgent)
​
input
object
Parameters passed to the task
​
result
object
Output result from the task

​
Example Request

curl -X GET "https://api.hirebase.org/v2/tasks/:task_id \
 -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY"

​
Example Response

{
    "id": "8107c787-16b9-4763-af74-e2c789a5169n",
    "type": "export_job_data",
    "state": "finished",
    "progress": 1.0,
    "created_at": "2025-06-13T06:10:07.605000",
    "updated_at": "2025-06-13T06:10:08.647000",
    "started_at": "2025-06-13T06:10:07.723000",
    "completed_at": "2025-06-13T06:10:08.647000",
    "user_id": "68876d278da1b42f2878be12",
    "error": null,
    "worker_id": "worker-81ghedc2-4",
    "priority": 0,
    "input": {
        "query": {
            "job_titles": [
                "Site/Civil Engineer"
            ],
            "keywords": null,
            "location_group": null,
            "location_types": [
                "In-Person"
            ],
            "geo_locations": [
                {
                    "city": "Richmond",
                    "region": "Virginia",
                    "country": "United States"
                }
            ],
            "experience": null,
            "yoe": {
                "min": 1.0,
                "max": 6.0
            },
            "include_yoe": null,
            "company_types": null,
            "company_name": "companyxyz",
            "date_posted": null,
            "days_ago": null,
            "month": null,
            "salary": null,
            "include_no_salary": null,
            "currency": null,
            "job_types": [
                "Full-time"
            ],
            "job_category": null,
            "industry": [
                "Design",
                "Construction"
            ],
            "sub_industry": [
                "Architecture",
                "Building Construction"
            ],
            "visa": "false",
            "include_expired": null,
            "hide_seen_jobs": null,
            "user_id": null,
            "company_slug": null,
            "job_slug": null,
            "job_board": null,
            "sort_by": "relevance",
            "sort_order": "desc",
            "page": 1,
            "limit": 10
        },
        "format": "json"
    },
    "result": {
        "download_url": "https://sfo3.digitaloceanspaces.com/joby-uploads/user/32245d278da1b42f2878fa12/0ff6c9b7-138f-4c14-b0d6-95425b81d75d.json?AWSAccessKeyId=DO007W2A88HAEEP9W6VH&Signature=WP0LSTZZNKRoIukxxhzkiW%2Fh5uI%3D&Expires=1752387007",
        "file_size": 3455,
        "record_count": 10,
        "expiry_time": "2025-07-13T06:10:08.024758"
    }
}

​
Error Responses

Returns when the API key is missing, invalid, or incorrect.
Returns when the provided task_id is not valid.
Returns when an unexpected error occurs on the server.
  • Occurs during unhandled server-side failures or bugs that prevent the request from being processed.