Segments
GET
Get Segment
GET /v1/segments/{segmentId}Retrieve a specific segment by ID with its conditions and member count.
Use Cases:
- Fetch segment details for campaign targeting
- Verify segment configuration
- Check current member count before sending
- Display segment information in UI
- Audit segment definitions
Behavior:
- Returns complete segment object with all conditions
- Includes current estimated member count (cached)
- Shows creation and last update timestamps
- Segment must belong to your workspace
- Member count updates periodically (may not be real-time)
Required Scope: read:segments
Response Includes:
- Segment identification (id, name, description)
- Complete filter conditions (MongoDB query format)
- Estimated member count (contacts matching conditions)
- Timestamps (createdAt, updatedAt)
- Segment metadata
Note: For real-time member count, use GET /v1/segments/{segmentId}/contacts to fetch actual matching contacts.
Path parameters
segmentIdstringrequiredSegment ID
Response
200Successfully retrieved segment with conditions, member count, and metadata
object"segment"requiredObject type identifier
idstringrequiredUnique segment identifier
namestringrequiredSegment name
descriptionstringnullSegment description
conditionsFieldCondition | TopicCondition | LogicalOperatorConditionrequiredA filter condition for segments and contact search. Can be a field comparison, topic subscription check, or logical operator combining multiple conditions.