---
title: "Bulk get hold/unhold events"
method: POST
path: "/public-api/v1/phone_call_legs/bulk_get_holds"
tags: ["phone_call_legs"]
---

# Bulk get hold/unhold events

`POST /public-api/v1/phone_call_legs/bulk_get_holds`

## Request

- Base URL: `/` (relative, and the document’s source URL is not known)
- URL: `/public-api/v1/phone_call_legs/bulk_get_holds`
- Auth: HTTP bearer and API key in header `x-tenant-code`

Fetch hold/unhold events for up to 100 calls in one request (``{"holds": [...]}``).

Unknown or other-tenant ids are skipped silently, so the list may be shorter.

## Request body

- CallDetailHoldListRequest: Request body for ``POST /phone_call_legs/bulk_get_holds`` (1..100 IDs; unknown skipped).
  - `call_detail_ids` string[], required: Call-detail IDs to fetch hold/unhold events for. 1 to 100 per request. Unknown IDs are skipped silently.

## Response `200`

Hold and unhold events for the requested phone call legs.

- CallDetailHoldListResponse: Response body for ``POST /phone_call_legs/bulk_get_holds`` (unknown IDs are skipped).
  - `holds` CallDetailHoldsEntry[], required
    - `call_detail_id` string, uuid, required
    - `holds` HoldEvent[]
      - `event_type` string, required
      - `event_at` string, date-time, required
      - `circuit_number` string, nullable
      - `circuit_name` string, nullable

## Other responses

- `400`: The tenant could not be resolved from the request.
- `401`: Error envelope (`public_api.unauthorized`).
- `403`: The request is not allowed for the current tenant or access configuration.
- `404`: Error envelope (`public_api.not_found`).
- `409`: Error envelope (`public_api.conflict`).
- `413`: The request body exceeds the maximum allowed size.
- `422`: Validation Error
- `429`: Rate limit exceeded. Wait for ``Retry-After`` seconds before retrying.
- `502`: Error envelope (`public_api.internal_error`).
- `503`: The request could not be served right now. Please retry.
- `504`: Error envelope (`public_api.request_timeout`).

---

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