Get task status

curl --request GET \
  --url https://api.example.com/v1/tasks/{request_id} \
  --header 'x-apikey: <x-apikey>'

{
  "request_id": "abc123",
  "status": "processing"
}

Tasks

Get request data or status

Retrieve the data (or results) of an enrichment run by the task id. If the request is still processing, the status field will show a ‘processing’ status, if the request is completed, your data will be returned in the ‘data’ key. The task or request ID is provided as a response when you launch an enrichment task.

Important: Data is stored for 1 hour only. After 1 hour, the data is permanently deleted and the status will return gone. Make sure to retrieve your results promptly.

GET

tasks

{request_id}

Get task status

curl --request GET \
  --url https://api.example.com/v1/tasks/{request_id} \
  --header 'x-apikey: <x-apikey>'

{
  "request_id": "abc123",
  "status": "processing"
}

Headers

x-apikey

any

required

API Key for authentication

Path Parameters

request_id

string

required

The unique identifier of the request whose status you are querying.

Response

The request status along with any associated data or errors.

request_id

string

Unique identifier of the request.

status

string

Current status of the request. Can be 'processing', 'completed', or 'failed'.

data

Resulting data if the request is completed. Can be a dictionary or null.

error

Error message if the request has failed.

Run bulk waterfall

Get user info

Overview

Workspace

Headless

User

Get request data or status

Headers

Path Parameters

Response