List saved segment contacts

Retained legacy exception: Read members of a saved segment; V3 evaluation does not take a saved segment ID.

Read members of a saved segment; V3 evaluation does not take a saved segment ID.

For preview, set isPreview=true and supply groups with at least one condition instead of segmentId. Saved-segment mode accepts supported CDP and system segment IDs. Page numbers <=0 become 1. This is numbered pagination, not a V3 cursor: continue until the returned page/total indicates completion. Do not expect nextCursor or hasNextPage from this wrapper.

Permissions

For API access tokens and OIDC tokens, satisfy at least one of: api, wati_integration:read. Legacy JWTs do not use this scope check. Allowed roles: DEVELOPER, ADMINISTRATOR, EXTERNAL_ADMINISTRATOR, PARTNER_ADMINISTRATOR, AI_OPERATOR or API_TOKEN. FLEXI_TRIAL and FLEXI_PAID are denied even with another listed role. Workspace and billing restrictions also apply. Saved-segment operations require account availability and a qualifying Pro or Business subscription. Denial can return 400 with result=false and info; scopes alone do not grant access.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Workspace ID; use the regional API host and matching workspace credential.

Body Params
string

Required unless isPreview=true.

integer
Defaults to 1
integer
Defaults to 100

Values <=0 become 100; values >100 are clamped to 100.

boolean
Defaults to false
groups
array of objects | null
groups
Responses

401

Unauthorized; a JSON body is not guaranteed.

403

Access denied by scopes, roles, workspace or billing; a JSON body is not guaranteed.

429

Rate or usage limit exceeded.

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json