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
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: 3/s
Steady: 60/m

Scopes:
Profiles Read

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

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