Sign in

v28

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

List Segments

List all segments in your workspace. Returns summary data including member counts. Supports pagination.

get/segments

Query parameters

pagenumber

Page number (default: 1).

Page number (default: 1).

pageSizenumber

Number of results per page (default: 50, max: 100).

Number of results per page (default: 50, max: 100).

Response

Segments 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.