v3

latestOpenAPI 3.1.1mit2026-07-3165481.5 MB
Lists
v1

Get Batch Remove from List Job

Retrieve the status of a batch remove-from-list job created via POST /v1/lists/batch-remove-from-list-jobs.

While status is running, results and summary are omitted. Once status becomes completed, results carries the per-item outcome and summary carries the per-outcome counts (including failed_count) together with list_size_after. On failed, errors describes the failure.

Credit Note: This endpoint does not consume credits.

:::info Requires the lists:read OAuth2 scope. :::

get/v1/lists/batch-remove-from-list-jobs/{job_id}

Path parameters

job_idstring required

The unique identifier of the batch remove-from-list job.

Query parameters

account_idstring required

The Leadfeeder Account ID. The Account ID can be retrieved using the List Accounts endpoint.

Response

Batch remove-from-list job status retrieved

Example response

{
  "data": {
    "type": "batch_remove_from_list_job",
    "id": "job_7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "attributes": {
      "status": "running",
      "configuration": {
        "list_id": "contact_456",
        "items": [
          {
            "type": "contact",
            "id": "3170656125"
          }
        ]
      },
      "results": [
        {
          "id": "3170656125",
          "type": "contact",
          "status": "removed"
        }
      ],
      "summary": {
        "removed": 2,
        "list_size_after": 49
      },
      "errors": [
        {
          "code": "job_failed",
          "title": "External contact data provider timeout"
        }
      ],
      "created_at": "2026-05-13T12:00:00Z",
      "completed_at": "2026-05-13T12:00:18Z"
    }
  },
  "meta": {
    "request_id": "cf054205-dd8c-4473-8689-07c30fe0789f"
  }
}