Skip to main content
GET
/
api
/
v2
/
background-jobs
/
{id}
Get background job
curl --request GET \
  --url https://api.instantly.ai/api/v2/background-jobs/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "675266e304a8e55b17f0228b",
  "workspace_id": "019cc043-af1d-74f8-bb1a-ebd9220e8d8e",
  "type": "move-leads",
  "progress": 0,
  "status": "pending",
  "created_at": "2026-03-05T23:09:47.165Z",
  "updated_at": "2026-03-05T23:09:47.165Z",
  "user_id": "019cc043-af1d-74f8-bb1a-ebdaab2b64ce",
  "entity_id": "019cc043-af1d-74f8-bb1a-ebdb698900fd",
  "entity_type": "list",
  "data": {}
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

The ID of the requested item

Example:

"69aa0d48cf7d23a11088cf86"

Query Parameters

​
data_fields
string

Comma-separated list of fields to include from the data object (e.g., "success_count,failed_count").

Example:

"success_count,failed_count,total_to_process"

Response

The requested Background Job

A background job that can be used to perform long-running tasks

​
id
string
required

Unique identifier for the background job

Example:

"675266e304a8e55b17f0228b"

​
workspace_id
string<uuid>
required

Workspace ID

Example:

"019cc043-af1d-74f8-bb1a-ebd9220e8d8e"

​
type
enum<string>
required

Type of background job

Available options:
move-leads,
import-leads,
export-leads,
update-warmup-accounts,
rename-variable
Example:

"move-leads"

​
progress
number
required

Progress of the job as a percentage (from 0 to 100)

Required range: 0 <= x <= 100
Example:

0

​
status
enum<string>
required

Job status

Available options:
pending,
in-progress,
success,
failed
Example:

"pending"

​
created_at
string
required

Timestamp when the job was created

Example:

"2026-03-05T23:09:47.165Z"

​
updated_at
string
required

Timestamp when the job was last updated

Example:

"2026-03-05T23:09:47.165Z"

​
user_id
null | string<uuid>

The id of the user that triggered the action that created the job

Example:

"019cc043-af1d-74f8-bb1a-ebdaab2b64ce"

​
entity_id
null | string<uuid>

The id of the entity that the job is related to

Example:

"019cc043-af1d-74f8-bb1a-ebdb698900fd"

​
entity_type
enum<string>

Type of entity

Available options:
list,
campaign,
workspace
Example:

"list"

​
data
object

Data about the job, used to store any additional information we need to process the job