Skip to main content
GET
Get background job

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:

"6a6471cfb0b0b2e80a3804a9"

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

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:

"019f985c-6325-7016-8026-da3ba794e60a"

type
enum<string>
required

Type of background job

Available options:
move-leads,
import-leads,
export-leads,
update-warmup-accounts,
rename-variable,
broadcast-ai-generate,
broadcast-website-scrape,
import-subscribers-from-crm,
resync-subscriber-crm-tags
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,
draining,
paused,
cancelled
Example:

"pending"

created_at
string
required

Timestamp when the job was created

Example:

"2026-07-25T08:20:19.365Z"

updated_at
string
required

Timestamp when the job was last updated

Example:

"2026-07-25T08:20:19.365Z"

user_id
null | string<uuid>
read-only

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

Example:

"019f985c-6325-7016-8026-da3cdc2bb21c"

entity_id
null | string<uuid>

The id of the entity that the job is related to

Example:

"019f985c-6325-7016-8026-da3d41c71779"

entity_type
enum<string>

Type of entity

Available options:
list,
campaign,
workspace,
broadcast,
subscriber-group-sync,
subscriber-group
Example:

"list"

data
object

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