Sign in

v1

latestOpenAPI 3.1.02026-07-2617125852.3 KB
BackgroundJob

List background job

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

get/api/v2/background-jobs

Query parameters

limitinteger
Example:10

The number of items to return

starting_afterstring
Example:507f1f77bcf86cd799439011
idsstring
Example:676f3caadedbfe9abea3bab4

The ID of the job. Multiple IDs can be provided as a comma-separated list

included_idsstring
Example:676f3caadedbfe9abea3bab4

The ID of the job to be included in the response. Multiple IDs can be provided as a comma-separated list

excluded_idsstring
Example:676f3caadedbfe9abea3bab4

The ID of the job to be excluded from the response. Multiple IDs can be provided as a comma-separated list

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'
Example:move-leads

The type of the job

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

The type of the entity

entity_idstring
Example:676f3caadedbfe9abea3bab4

The ID of the entity. Multiple IDs can be provided as a comma-separated list

statusstring
Example:pending,in-progress

The status of the job. Multiple statuses can be provided as a comma-separated list. Valid statuses are: pending, in-progress, success, failed, draining, paused, cancelled

sort_column'created_at' | 'updated_at'
Example:created_at

The column to sort the results by

sort_order'asc' | 'desc'
Example:desc

The order to sort the results by

Response

The list of Background Job

next_starting_afterstring

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

Example response

{
  "items": [
    {
      "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"
    }
  ],
  "next_starting_after": "019f94cd-ae00-7397-9fda-45ad66a17436"
}