Skip to main content
GET
Segment details
Use this endpoint to retrieve one segment’s full configuration, including its parsed filter conditions and parent audience.

Endpoint

GET /segment/details Authentication: Required (workspace auth)

Query Parameters

Response

filter_conditions is only populated when the segment’s stored filter is in the flat { field, operator, value } shape written by Update Segment. A segment that has never been updated since Create Segment stores its filter as a CONDITIONLIST tree instead, which this endpoint doesn’t parse — for such segments filter_conditions is returned as an empty array even though the segment does have a filter applied.

Error Cases

Example cURL

Headers

token
string
required

API token for authentication

Query Parameters

segment_id
integer
required

Segment identifier

Response

Segment details retrieved successfully

id
integer
segment_name
string
description
string
audience_id
integer
audience_name
string
match_type
enum<string>
Available options:
all,
any
filter_conditions
object[]
tags
string[]
total_contacts
integer
status
enum<integer>
Available options:
0,
1,
2
updated_date
string