HomeGuidesAPI Reference
ChangelogHelp CenterCommunityContact Us
API Reference
These docs are for a deprecated API version. Click here to use the latest version.

Get Segment Profiles

Get all profiles within the given segment ID.
Filter to request a subset of all profiles. Profiles can be filtered by email, phone_number, and push_token fields.
You can adjust the number of results per page via the page[size] query parameter, e.g. ?page[size]=25. Default: 20. Max: 100.

Rate limits:
Burst: 10/s
Steady: 150/m

Scopes:
Profiles Read
Segments Read

Path Params
string
required
Query Params
array of strings
fields[profile]
string

For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#filtering
Allowed field(s)/operator(s):
email: any
phone_number: any
push_token: any
_kx: equals

integer

The number of results to return per page. Default = 20. Max = 100

Headers
string
required
Defaults to 2023-01-24

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

Responses

Language
Credentials