HomeGuidesAPI Reference
ChangelogHelp CenterCommunityContact Us
API Reference

Get Profiles for Segment

Get all profiles within a segment with the given segment ID.

Filter to request a subset of all profiles. Profiles can be filtered by email, phone_number, push_token, and joined_group_at fields. Profiles can be sorted by the following fields, in ascending and descending order: joined_group_at

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

Scopes:
profiles:read
segments:read

Path Params
string
required

Primary key that uniquely identifies this segment. Generated by Klaviyo.

Query Params
array of strings

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

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

For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
email: any, equals
phone_number: any, equals
push_token: any, equals
_kx: equals
joined_group_at: greater-or-equal, greater-than, less-or-equal, less-than

integer
1 to 100
Defaults to 20

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

Headers
string
required
Defaults to 2025-01-15

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

Responses

Language
Credentials