Skip to main content
GET
/
v1
/
background_jobs
List jobs
curl --request GET \
  --url https://{environment}.userpilot.io/v1/background_jobs \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '{}'
[
  {
    "elapsed_time": 123,
    "end_time": "<string>",
    "file_size": 123,
    "filename": "<string>",
    "job_id": "<string>",
    "links": "<string>",
    "start_time": "<string>",
    "total_rows": 123,
    "type": "<string>"
  }
]

Documentation Index

Fetch the complete documentation index at: https://docs.userpilot.com/llms.txt

Use this file to discover all available pages before exploring further.

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.

Body

application/json

The body is of type object.

Response

200 - application/json

OK - List jobs

ā€‹
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