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.

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

Scopes:
profiles:read
segments:read

Path Params
string
required
Query Params
array of strings

Request additional fields not included by default in the response. Supported values: 'predictive_analytics'

additional-fields[profile]
array of strings
fields[profile]
string

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

integer
1 to 100
Defaults to 20

Default: 20. Min: 1. Max: 100.

Headers
string
required
Defaults to 2023-06-15

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

Responses

Language
Credentials