INinstantly
BackgroundJob

Get background job

Changed on

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

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

Request

  • Base URL
    https://api.instantly.ai
  • URL
    https://api.instantly.ai/api/v2/background-jobs/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required
Example:6ae9125074e3fc66354664ff

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' | 'journey-ai-build' | 'delete-leads' 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' | 'journey'

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": "01a19e6f-5092-7ff5-a1b6-054e30b4b86f",
  "user_id": "01a19e6f-5092-7ff5-a1b6-054f63cc967a",
  "type": "move-leads",
  "entity_id": "01a19e6f-5092-7ff5-a1b6-055094f70e2b",
  "entity_type": "list",
  "data": {
    "moved_lead_emails": [
      "jane@example.com",
      "john@example.com"
    ],
    "skipped_duplicate_emails": [
      "jane@example.com"
    ],
    "skipped_in_other_campaigns_emails": [
      "jane@example.com"
    ],
    "skipped_blocklisted_emails": [
      "jane@example.com"
    ]
  },
  "status": "pending",
  "created_at": "2026-11-02T22:44:17.682Z",
  "updated_at": "2026-11-02T22:44:17.682Z"
}

Changes

  • c781051105a8Revision changes
    • warning

      added the new delete-leads enum value to the response property for the response status

    • warning

      added the new journey enum value to the response property for the response status

    • warning

      added the new journey-ai-build enum value to the response property for the response status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status