HomeGuidesAPI Reference
ChangelogHelp CenterCommunityContact Us
API Reference

Get Segments

🚧

This endpoint is in beta and subject to change.

A beta revision header (2024-05-15.pre) is required to use our beta APIs. Klaviyo APIs in beta are not intended for use in production. See our versioning and deprecation policy for more information.

Get all segments in an account.

Filter to request a subset of all segments. Segments can be filtered by name, created, and updated fields.

Returns a maximum of 10 results per page.

Rate limits:
Burst: 75/s
Steady: 700/m

Scopes:
segments:read

Query Params
array of strings
fields[segment]
array of strings
fields[tag]
string

For more information please visit https://developers.klaviyo.com/en/v2024-05-15.pre/reference/api-overview#filtering
Allowed field(s)/operator(s):
name: any, equals
id: any, equals
created: greater-than
updated: greater-than
is_active: any, equals
is_starred: equals

array of strings
include
Headers
string
required
Defaults to 2024-05-15.pre

API endpoint revision (format: YYYY-MM-DD[.suffix])

Responses

Language
Credentials