USuseboom
Segments

Get a segment

Changed on

Get one segment by slug, with a live member count.

get/api/v1/segments/{slug}

Request

  • Base URL
    https://www.useboom.ai
  • Auth
    HTTP bearer

Path parameters

slugstring required

The segment slug, as returned by segments_list.

Response

Success

idstring required

Stable internal identifier. Pass this wherever a segment reference is stored — e.g. a journey trigger's segmentId.

slugstring required

Unique identifier within your organization.

namestring required
descriptionstring nullable required
evaluationCadence'REACTIVE_ONLY' | 'HOURLY' | 'DAILY' required

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

memberCountinteger required

Live count of currently active members.

includeBoomCreatedboolean required

Whether people Boom created for contacts who messaged you first can match. False by default.

lastEvaluatedAtstring nullable required

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

createdAtstring required

ISO 8601 timestamp.

Changes

  • 7c7a773b12ceRevision changes
    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status