Get background job

Requires one of the following scopes: background-jobs:read, background-jobs:all, all:read, all:all

GET /api/v2/background-jobs/{id}

Get background job

cURL

curl --request GET \
  --url https://api.instantly.ai/api/v2/background-jobs/{id} \
  --header 'Authorization: Bearer <token>'

200

{
  "id": "675266e304a8e55b17f0228b",
  "workspace_id": "019e3bd1-8de0-718e-98a7-c64a90181c29",
  "type": "move-leads",
  "progress": 0,
  "status": "pending",
  "created_at": "2026-05-18T16:00:49.632Z",
  "updated_at": "2026-05-18T16:00:49.632Z",
  "user_id": "019e3bd1-8de0-718e-98a7-c64b49b3b43b",
  "entity_id": "019e3bd1-8de0-718e-98a7-c64caaca673c",
  "entity_type": "list",
  "data": {
    "moved_lead_emails": [
      "[e-mail]",
      "[e-mail]"
    ]
  }
}

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:

"6a0b37bb2a086e643d76cd51"

Query Parameters

data_fields · string

Comma-separated list of fields to include from the data object (e.g., "success_count,failed_count" or "moved_lead_emails,moved_leads"). For move-leads jobs, moved_lead_emails is capped at 10,000 entries.

Example:

"success_count,failed_count,total_to_process"

Response

200

application/json

The requested Background Job

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

id · string · required · read-only

Unique identifier for the background job

Example:

"675266e304a8e55b17f0228b"

workspace_id · string<uuid> · required · read-only

Workspace ID

Example:

"019e3bd1-8de0-718e-98a7-c64a90181c29"

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-05-18T16:00:49.632Z"

updated_at · string · required

Timestamp when the job was last updated

Example:

"2026-05-18T16:00:49.632Z"

user_id · null | string<uuid> · read-only

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

Example:

"019e3bd1-8de0-718e-98a7-c64b49b3b43b"

entity_id · null | string<uuid>

The id of the entity that the job is related to

Example:

"019e3bd1-8de0-718e-98a7-c64caaca673c"

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

Show child attributes