Boom Ai

Boom Ai Segments API

The Segments API from Boom Ai — 7 operation(s) for segments.

GitHub OpenAPI
Business capability
Customer Segmentation Management BC-420.20

Operations 10

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /api/v1/segments List my audience segments · List segments #
Ask an LLM
“Which audience segments does my organization have?”
“Are archived segments included when I list my segments?”
Tell an agent
List my active segments.
Show the next page of segments after cursor {cursor}.
POST /api/v1/segments Create an audience segment · Create a segment #
Ask an LLM
“How do I save a new audience of people based on attributes and events?”
“Can a new segment re-evaluate itself every day at a set hour?”
Tell an agent
Create segment {name} with slug {slug} using filter {filterExpression}.
Save a new segment {name} ({slug}) for {filterExpression} that evaluates daily at hour {dailyEvaluationHour}.
DELETE /api/v1/segments/{slug} Delete a segment · Delete a segment #
Ask an LLM
“What happens to journeys triggered by a segment when I delete it?”
“How do I remove a segment I no longer need?”
Tell an agent destructive · confirm first
Delete segment {slug}.
Remove segment {slug} and disconnect its journey triggers.
GET /api/v1/segments/{slug} Get a segment and its member count · Get a segment #
Ask an LLM
“How many people are in a given segment right now?”
“What filter and settings does one segment use?”
Tell an agent
Show segment {slug}.
Get the live member count for segment {slug}.
PATCH /api/v1/segments/{slug} Update a segment's filter or settings · Update a segment #
Ask an LLM
“If I change a segment's filter, does its membership update right away?”
“Can I switch an existing segment to skip weekend evaluations?”
Tell an agent
Change the filter on segment {slug} to {filterExpression}.
Rename segment {slug} to {name}.
POST /api/v1/segments/{slug}/evaluate Re-evaluate a segment's membership now · Evaluate a segment now #
Ask an LLM
“Can I refresh who is in a segment immediately instead of waiting for its schedule?”
“How long does an on-demand segment evaluation take?”
Tell an agent
Evaluate segment {slug} now.
Recompute membership for segment {slug} right away.
GET /api/v1/segments/{slug}/members List the people in a segment · List segment members #
Ask an LLM
“Who exactly is in a segment?”
“Can I page through a large segment's members?”
Tell an agent
List the members of segment {slug}.
Show {limit} members of segment {slug}.
GET /api/v1/segments/catalog Get the segment filter catalog · Get the segment filter catalog #
Ask an LLM
“What attributes, related data and computed variables can I filter a segment on?”
“Which operators work with each filterable field when building a segment?”
Tell an agent
Show me everything I can filter segments on.
Get the segment filter catalog with tokens and operators.
POST /api/v1/segments/preview Count people matching a filter · Preview a segment filter #
Ask an LLM
“How many people would a filter match before I save it as a segment?”
“Can I size an audience without creating anything?”
Tell an agent
Preview how many people match {filterExpression}.
Count the current audience for this filter: {filterExpression}.
POST /api/v1/segments/validate Validate a segment filter · Validate a segment filter #
Ask an LLM
“Is my segment filter expression valid, and which field is wrong if not?”
“Can I check a filter against my live catalog without saving it?”
Tell an agent
Validate the segment filter {filterExpression}.
Check this filter for errors before I save it: {filterExpression}.

Documentation

📖
Documentation
https://docs.useboom.ai
📖
APIReference
https://docs.useboom.ai/api-reference/overview

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/boom-ai/refs/heads/main/openapi/boom-ai-segments-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/boom-ai:boom-ai-segments-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

boom-ai-segments-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Boom Segments API
  version: 1.0.0
  description: 'Boom''s public REST API — one uniform surface over every platform capability. CDP: upsert people and custom objects, define object and relationship types, link and unlink relationships, and record behavioral events — one record per request or up to 1000 per request via the `/batch` endpoints. Segments: read (list, read, membership) and full authoring — discover the filterable catalog, validate a filter, create and update segments, preview match counts, and trigger evaluation. Initiatives: create and configure outreach initiatives, link WhatsApp templates, drive the lifecycle (launch, cancel, archive), and read collected-data summaries. Participants: enroll people into an active initiative, track their status, read conversation transcripts, and stop outreach. Journeys: read-only access to always-on message flows and their metrics. WhatsApp templates: list your WhatsApp numbers and list, read, and create message templates. The same capabilities are exposed as MCP tools with identical schemas.'
servers:
- url: https://www.useboom.ai
  description: Production
- url: https://dev.useboom.ai
  description: Development (sandbox — use a development organization API key)
security:
- bearerAuth: []
tags:


# --- truncated at 32 KB (272 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/boom-ai/refs/heads/main/openapi/boom-ai-segments-api-openapi.yml