v28

latestOpenAPI 3.1.0raw.githubusercontent.com2026-05-013593344.3 KB

Segments

Get Segment

Get detailed information about a specific segment, including its filter configuration, description, and metadata. Accepts either a UUID or a preset ID for system segments.

get/segments/{segmentId}

Path parameters

segmentIdstring required

The segment ID (UUID) or preset ID for system segments.

Response

Segment retrieved successfully

idstring uuid required

The segment ID.

namestring required

The segment name.

type'system' | 'custom' required

Whether the segment is system-defined or custom.

presetIdstring nullable required

Preset identifier for system segments.

memberCountnumber required

Number of participants in this segment.

isFavoritedboolean required

Whether the segment is favorited.

descriptionstring nullable required

A description of the segment.

iconstring nullable required

Icon identifier for the segment.

filtersobject required

The filter/rule configuration for the segment.

createdBystring uuid nullable required

The user ID who created this segment.

createdAtstring date-time required

When the segment was created.

updatedAtstring date-time required

When the segment was last updated.