cURL
curl --request GET \ --url 'https://{environment}.userpilot.io/v1/background_jobs/{{job_id}}' \ --header 'Authorization: <authorization>' \ --header 'Content-Type: application/json' \ --data ' { "users": [ { "user_id": "<string>", "company_id": "<string>", "metadata": { "custom_user_property": "<string>" } } ] } '
{ "completed_rows": 123, "elapsed_time": 123, "end_time": "<string>", "file_size": 123, "filename": "<string>", "job_id": "<string>", "links": "<string>", "start_time": "<string>", "status": "queued", "total_rows": 123, "type": "<string>" }
Fetches the status of a specific import job by its job_id.
API authentication token in the format: Token {{API_KEY}} Obtain your API key from the Userpilot Environment Settings.
Token {{API_KEY}}
Show child attributes
example: Name, Job title, etc.
OK - Check job status
queued
validating
processing
pending_refresh
completed
failed
Was this page helpful?