REST API reference

Segments

Saved filters of people and companies, with how many match right now.

Segments are built in the dashboard. Use their ids to filter contacts and companies. Needs segments:read.

The segment object

A saved segment.

Fields

object string: Always segment.
id string: Unique id.
name string: Segment name.
entity enum: contact or company.
count integer: Matching people or companies right now.
createdAt timestamp: Created.
updatedAt timestamp: Last change.

Example segment

{  "object": "segment",  "id": "0199a8f6-8c9d-7e0f-8a1b-2c3d4e5f6a7b",  "name": "Business plan customers",  "entity": "contact",  "count": 342,  "createdAt": "2025-06-18T12:00:00.000Z",  "updatedAt": "2026-08-03T09:45:00.000Z"}

List segments

GET /v1 /segments segments:read

Every saved segment with live counts. Not paginated. GET /segments/{id} returns one.

Query parameters

entity enum: contact or company.

curl https://api.rabbitblaze.com/v1/segments \  -H "Authorization: Bearer $RABBITBLAZE_API_KEY"

const res = await fetch("https://api.rabbitblaze.com/v1/segments", {  headers: {    Authorization: `Bearer ${process.env.RABBITBLAZE_API_KEY}`,  },})const data = await res.json()

import osimport requests res = requests.get(    "https://api.rabbitblaze.com/v1/segments",    headers={"Authorization": f"Bearer {os.environ['RABBITBLAZE_API_KEY']}"},)res.raise_for_status()data = res.json()

Response · 200 OK

{  "items": [    {      "object": "segment",      "id": "0199a8f6-8c9d-7e0f-8a1b-2c3d4e5f6a7b",      "name": "Business plan customers",      "entity": "contact",      "count": 342,      "createdAt": "2025-06-18T12:00:00.000Z",      "updatedAt": "2026-08-03T09:45:00.000Z"    }  ],  "nextCursor": null}