---
title: "Get Engagement Attempt Batch"
method: GET
path: "/admin/engagement-attempt-batches/{batch_id}"
tags: ["admin", "engagement-attempt-batches"]
---

# Get Engagement Attempt Batch

`GET /admin/engagement-attempt-batches/{batch_id}`

## Request

- Base URL: `https://api-docs.upsmith.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api-docs.upsmith.com/admin/engagement-attempt-batches/{batch_id}`
- Auth: one of:
  - API key in header `x-api-key`
  - HTTP bearer

Get a single engagement attempt batch with computed stats and cursor-paginated per-customer attempts.

## Path parameters

- `batch_id` string, required

## Query parameters

- `attempts_cursor` string, nullable
- `attempts_limit` integer

## Headers

- `organization-id` string, nullable
- `timezone` string
- `x-user-id` string, nullable
- `x-actor-email` string, nullable
- `x-request-source` string, nullable
- `x-operation-id` string, nullable
- `x-commit-message` string, nullable
- `x-confirmation-id` string, nullable
- `x-chat-id` string, nullable

## Response `200`

Successful Response

- BatchDetailResponse
  - `id` string, required
  - `status` string, required
  - `expected_attempts` integer, required
  - `runner_version` string, required
  - `created_at` string, date-time, required
  - `updated_at` string, date-time, required
  - `agent` BatchAgentResponse
    - `id` string, required
    - `title` string, required
  - `organization` BatchOrgResponse
    - `id` string, required
    - `name` string, required
  - `campaign_send_id` string, nullable
  - `stats` BatchStatsResponse, required
    - `total` integer, required
    - `sent` integer, required
    - `blocked` integer, required
    - `in_flight` integer, required
    - `by_reason` object, required
  - `attempts` BatchAttemptPageResponse, required
    - `items` AttemptResponse[], required
      - `id` string, required
      - `st_customer_id` integer, nullable
      - `contact_id` string, nullable
      - `contact_method_id` string, nullable
      - `engagement_id` string, nullable
      - `did_not_start_reason` string, nullable
      - `retry_count` integer, required
      - `last_error` string, nullable
      - `created_at` string, date-time, required
      - `updated_at` string, date-time, required
    - `cursor` string, nullable

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/upsmith/apis/upsmith-api.md) - [All operations](https://skmtc.dev/upsmith/apis/upsmith-api/llms.txt) - [OpenAPI document](https://skmtc.dev/upsmith/apis/upsmith-api/revisions/cce8b07a5787?raw)