Sign in

v1

latestOpenAPI 3.1.02026-07-2617125852.3 KB
BackgroundJob

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}

Path parameters

idstring required
Example:6a63889f51334cd9cabec6f3

The ID of the requested item

Query parameters

data_fieldsstring
Example:success_count,failed_count,total_to_process

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.

Response

The requested Background Job

idstring required

Unique identifier for the background job

workspace_idstring uuid required

Workspace ID

user_idstring uuid nullable

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

type'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' required

Type of background job

entity_idstring uuid nullable

The id of the entity that the job is related to

entity_type'list' | 'campaign' | 'workspace' | 'broadcast' | 'subscriber-group-sync' | 'subscriber-group'

Type of entity

progressnumber required

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

status'pending' | 'in-progress' | 'success' | 'failed' | 'draining' | 'paused' | 'cancelled' required

Job status

created_atstring required

Timestamp when the job was created

updated_atstring required

Timestamp when the job was last updated

Example response

{
  "id": "675266e304a8e55b17f0228b",
  "workspace_id": "019f94cd-83be-78a1-8302-7d0e7112d2ad",
  "user_id": "019f94cd-83be-78a1-8302-7d0f5fbd1ead",
  "type": "move-leads",
  "entity_id": "019f94cd-83be-78a1-8302-7d1079f61d26",
  "entity_type": "list",
  "data": {
    "moved_lead_emails": [
      "jane@example.com",
      "john@example.com"
    ]
  },
  "status": "pending",
  "created_at": "2026-07-24T15:45:24.414Z",
  "updated_at": "2026-07-24T15:45:24.414Z"
}