Skip to main content
GET
List segments

Authorizations

Authorization
string
header
required

API key authentication. Use your API key as the bearer token.

Query Parameters

tags
string

Comma-separated tags to filter by (AND logic)

Example:

"newsletter,vip"

Response

List of segments

id
string<uuid>
required
Example:

"123e4567-e89b-12d3-a456-426614174000"

organization_id
string<uuid>
required
name
string
required
description
string | null
required
type
enum<string>
required

Segment type: 'manual' or 'data_driven'

Available options:
manual,
data_driven
Example:

"data_driven"

conditions
object
required
tags
string[]
required

Tags for categorization.

Example:
created_by
string<uuid> | null
required
created_at
string<date-time>
required
updated_at
string<date-time>
required