Skip to main content
GET
List saved contact segments.

Authorizations

x-api-key
string
header
required

Your workspace API key. It both authenticates the caller and selects the workspace.

Query Parameters

q
string

Filter segments by name (case-insensitive partial match).

with_counts
integer

Set to 1 to include a live contacts_count on each segment. Off by default because the count runs a matching query per segment; without it the field is omitted from list rows entirely.

per_page
integer

Items per page (alias: limit). Default 25, max 100.

Response

A paginated list.

A paginated collection. per_page defaults to 25 and is capped at 100.

data
object[]
meta
object