Skip to main content

Segments API

The Segments API lets you manage reusable user segments programmatically.

MethodEndpointDescription
GET/api/segmentsList all segments in a project
POST/api/segmentsCreate a new segment
GET/api/segments/:keyGet a segment by key
PUT/api/segments/:keyUpdate a segment
DELETE/api/segments/:keyDelete a segment

Segment objects include the segment key, name, description, and matching rules. Rules define which users belong to the segment based on attribute conditions. All endpoints require a valid JWT token.

note

Full request/response schemas and examples are coming soon.