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

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

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: '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):
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

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