Skip to main content
GET
List candidate segments

Authorizations

Authorization
string
header
required

Supabase JWT — Authorization: Bearer <token>.

Query Parameters

merchant_id
string<uuid>

Optional merchant to scope to. Admins and sub-merchant operators only; other callers always use their token's merchant.

Example:

"28106cba-1c27-4e53-b149-32113e5e8e31"

segment_id
string<uuid>

Segment id (profile_interview_segment.id). With it, the answer holds that one segment with its rules, analytics and position links.

Response

The segments.

data
object[]
required

Segments, last changed first; with segment_id, that one segment.