HomeGuidesAPI Reference
ChangelogHelp CenterCommunityContact Us
API Reference

Get Profiles

Get all profiles in an account.

Profiles can be sorted by the following fields in ascending and descending order: id, created, updated, email, subscriptions.email.marketing.suppression.timestamp, subscriptions.email.marketing.list_suppressions.timestamp

Use the additional-fields parameter to include subscriptions and predictive analytics data in your response.

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

Rate limits when using the additional-fields[profile]=predictive_analytics parameter in your API request:
Burst: 10/s
Steady: 150/m

To learn more about how the additional-fields parameter impacts rate limits, check out our Rate limits, status codes, and errors guide.

Scopes:
profiles:read

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):
id: any, equals
email: any, equals
phone_number: any, equals
external_id: any, equals
_kx: equals
created: greater-than, less-than
updated: greater-than, less-than
subscriptions.email.marketing.list_suppressions.reason: equals
subscriptions.email.marketing.list_suppressions.timestamp: greater-or-equal, greater-than, less-or-equal, less-than
subscriptions.email.marketing.list_suppressions.list_id: equals
subscriptions.email.marketing.suppression.reason: equals
subscriptions.email.marketing.suppression.timestamp: 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