Skip to main content
GET
/
v1
/
background_jobs
/
{job_id}
{
  "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>"
}

Headers

​
Content-Type
string
​
Accept
string
​
Authorization
string
default:Token ABC_1234_EFGH_5678
required

API authentication token in the format: Token {{API_KEY}} Obtain your API key from the Userpilot Environment Settings.

Path Parameters

​
job_id
string
required

Body

application/json
​
users
object[]

Response

200 - application/json

OK - Check job status

​
completed_rows
integer
​
elapsed_time
integer
​
end_time
string<style>
​
file_size
integer
​
filename
string
​
job_id
string<uri>
​
links
string<style>
​
start_time
string
​
status
enum<string>
Available options:
queued,
validating,
processing,
pending_refresh,
completed,
failed
​
total_rows
integer
​
type
string
⌘I