Get Profiles

get

https://a.klaviyo.com/api/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

fields[profile]

array of strings

For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets

fields[profile]

filter

string

For more information please visit https://developers.klaviyo.com/en/v2022-10-17/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

page[cursor]

string

For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#pagination

sort

string

enum

For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sorting

page[size]

integer

The number of results to return per page. Default = 20. Max = 100

Headers

revision

string

required

Defaults to 2022-10-17

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

Responses

200

4XXClient Error

5XXServer Error