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

# API

> The REST API for acting on your customer data — build audiences, run WhatsApp initiatives, and read back results.

The Boom REST API turns the customer data in your [CDP](/cdp/overview) into
action: define audiences, launch outbound WhatsApp initiatives, and read back
what they collect. Every endpoint here is also available as an
[MCP tool](/use-mcp) with the same name and schema — see
[one uniform surface](/one-surface).

## Base URL

All endpoints live under `/api/v1`:

```
https://www.useboom.ai/api/v1
```

<Info>
  Every request is authenticated with an **organization API key** sent as a
  Bearer token. The organization is derived from the key — you never pass an
  org id. See [Authentication](/authentication).
</Info>

## What you can do

<CardGroup cols={2}>
  <Card title="Segments" icon="blend">
    Saved audiences built from your people and their data. Discover what's
    filterable, validate and preview a filter, create and update segments, and
    page through their members.
  </Card>

  <Card title="Initiatives" icon="rocket">
    Outbound WhatsApp campaigns with a goal. Create one, link its templates,
    launch it, manage participants, and read back a summary of what it
    collected.
  </Card>

  <Card title="Journeys" icon="route">
    Always-on, event-triggered message flows. List them and read one —
    including live status and metrics.
  </Card>

  <Card title="WhatsApp templates" icon="message-square-text">
    The pre-approved messages initiatives and journeys send. List your WhatsApp
    numbers, then list, read, and create templates.
  </Card>
</CardGroup>

## Common use cases

* **Launch a campaign end to end.** Build a segment of the people you want to
  reach (`POST /api/v1/segments`), create an initiative (`POST /api/v1/initiatives`),
  link a WhatsApp template (`POST /api/v1/initiatives/{id}/templates`), then
  launch it (`POST /api/v1/initiatives/{id}/launch`).
* **Read back results.** Poll an initiative's data summary
  (`GET /api/v1/initiatives/{id}/data/summary`) and read individual participant
  transcripts (`GET /api/v1/initiatives/{id}/participants/{participantId}/messages`).
* **Automate outreach.** Drive audiences and initiatives from your own backend,
  on a schedule or in response to events.

## Conventions

* **One record or many.** Most write endpoints process one record; the `/batch`
  variants accept up to 1000 at once.
* **Pagination.** List endpoints return a `nextCursor`; pass it back as `cursor`
  to page forward.
* **Errors.** Every error responds with `{ "error": { "code", "message" } }` and
  an HTTP status. See [Rate limits & errors](/rate-limits-and-errors).

## Getting data in

Acting on data assumes the data is already in Boom. To push or sync people,
objects, events, and relationships, see the [CDP](/cdp/overview).