> ## Documentation Index
> Fetch the complete documentation index at: https://docs.theomnibot.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Get a Broadcast by ID or Name via the ChatbotX API

> Use GET /api/v1/broadcasts/{idOrName} to retrieve full details for a single ChatbotX broadcast by ID or name, including status and scheduling information.

Use this endpoint to fetch the complete details of a specific broadcast. You can identify the broadcast by either its numeric ID or its exact name. The response includes status, scheduling type, scheduled time, contact count, and the associated flow ID.

<Info>
  **GET** `/api/v1/broadcasts/{idOrName}`
</Info>

## Path Parameters

<ParamField path="idOrName" type="string" required>
  The unique ID or exact name of the broadcast to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl --request GET \
    --url 'https://app.chatbotx.io/api/v1/broadcasts/brd_001' \
    --header 'Authorization: Bearer <token>'
  ```

  ```python Python theme={null}
  import requests

  url = "https://app.chatbotx.io/api/v1/broadcasts/brd_001"

  headers = {"Authorization": "Bearer <token>"}

  response = requests.get(url, headers=headers)
  print(response.json())
  ```

  ```javascript JavaScript theme={null}
  const options = {
    method: 'GET',
    headers: { Authorization: 'Bearer <token>' }
  };

  fetch('https://app.chatbotx.io/api/v1/broadcasts/brd_001', options)
    .then(res => res.json())
    .then(res => console.log(res))
    .catch(err => console.error(err));
  ```
</CodeGroup>

## Response

Returns `200 OK` with a single broadcast object.

### Response Fields

<ResponseField name="id" type="string" required>
  The unique identifier of the broadcast.
</ResponseField>

<ResponseField name="name" type="string" required>
  The display name of the broadcast.
</ResponseField>

<ResponseField name="status" type="string" required>
  The current status of the broadcast. One of `scheduled`, `sending`, or `sent`.
</ResponseField>

<ResponseField name="schedulesType" type="string" required>
  Whether the broadcast was sent immediately or at a future time. One of `now` or `future`.
</ResponseField>

<ResponseField name="schedulesAt" type="string" required>
  ISO 8601 timestamp indicating when the broadcast is scheduled to send.
</ResponseField>

<ResponseField name="contactCount" type="integer | null" required>
  The number of contacts targeted by this broadcast, or `null` if not yet calculated.
</ResponseField>

<ResponseField name="flowId" type="string | null">
  The ID of the automation flow linked to this broadcast, or `null` if no flow is linked.
</ResponseField>

### Example Response

```json theme={null}
{
  "id": "brd_001",
  "name": "Black Friday Sale",
  "status": "scheduled",
  "schedulesType": "future",
  "schedulesAt": "2024-11-29T08:00:00Z",
  "contactCount": 5240,
  "flowId": "301"
}
```