---
title: "List background job"
method: GET
path: "/api/v2/background-jobs"
tags: ["BackgroundJob"]
---

# List background job

`GET /api/v2/background-jobs`

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

## Query parameters

- `limit` integer
- `starting_after` string
- `ids` string
- `included_ids` string
- `excluded_ids` string
- `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'
- `entity_type` 'list' | 'campaign' | 'workspace' | 'broadcast' | 'subscriber-group-sync' | 'subscriber-group'
- `entity_id` string
- `status` string
- `sort_column` 'created_at' | 'updated_at'
- `sort_order` 'asc' | 'desc'

## Response `200`

The list of Background Job

- object
  - `items` BackgroundJob[], required — The list of Background Job
    - `id` string, required — Unique identifier for the background job
    - `workspace_id` string, uuid, required — Workspace ID
    - `user_id` string, 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_id` string, 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
    - `data` object — Data about the job, used to store any additional information we need to process the job
      - `moved_lead_emails` string[] — For `move-leads` jobs, up to the first 10,000 email addresses of leads that actually moved or copied to the destination after all filters were applied. Use `moved_leads` for the full count.
    - `progress` number, 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_at` string, required — Timestamp when the job was created
    - `updated_at` string, required — Timestamp when the job was last updated
  - `next_starting_after` string — The filter for getting the next items after this one, this could either be a UUID, a timestamp, on an email depending on the specific API

## Other responses

- `401` — This request is unauthorized (either the Authorization header is missing or invalid, or the API key has been revoked)
- `402` — This request cannot be fulfilled because the workspace does not have an active paid plan
- `404` — The requested resource was not found
- `429` — You have exceeded the rate limit. Please check the rate limit docs for more information.

---

[API](https://skmtc.net/instantly/apis/api-explorer.md) · [All operations](https://skmtc.net/instantly/apis/api-explorer/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/instantly/api-explorer/revisions/378d1e253fe7/schema)