Skip to main content
GET
Get a segment

Authorizations

Authorization
string
header
required

Organization API key, sent as Authorization: Bearer boom_org_....

Path Parameters

slug
string
required

The segment slug, as returned by segments_list.

Minimum string length: 1

Response

Success

slug
string
required

Unique identifier within your organization.

name
string
required
description
string | null
required
evaluationCadence
enum<string>
required

How often the segment is re-evaluated. REACTIVE_ONLY segments only change when evaluated explicitly.

Available options:
REACTIVE_ONLY,
HOURLY,
DAILY
memberCount
integer
required

Live count of currently active members.

Required range: -9007199254740991 <= x <= 9007199254740991
lastEvaluatedAt
string | null
required

ISO 8601 timestamp; null if the segment has never evaluated.

createdAt
string
required

ISO 8601 timestamp.