Get Profiles

GET {{baseUrl}}/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, subscriptions.email.marketing.suppression.timestamp, subscriptions.email.marketing.list_suppressions.timestamp

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

Request Params

KeyDatatypeRequiredDescription
additional-fields[profile]stringRequest additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'
fields[profile]stringFor more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
filterstringFor more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):<br>id: any, equals<br>email: any, equals<br>phone_number: any, equals<br>external_id: any, equals<br>_kx: equals<br>created: greater-than, less-than<br>updated: greater-than, less-than<br>subscriptions.email.marketing.suppression.timestamp : greater-than, greater-or-equal, less-than, less-or-equal<br>subscriptions.email.marketing.suppression.reason : equals<br>subscriptions.email.marketing.list_suppressions.list_id : equals<br>subscriptions.email.marketing.list_suppressions.reason : equals<br>subscriptions.email.marketing.list_suppressions.timestamp : greater-than, greater-or-equal, less-than, less-or-equal
page[cursor]stringFor more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
page[size]numberDefault: 20. Min: 1. Max: 100.
sortstringFor more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting

HEADERS

KeyDatatypeRequiredDescription
revisionstring(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])
Acceptstring

RESPONSES

status: OK

{&quot;data&quot;:[{&quot;type&quot;:&quot;profile&quot;,&quot;attributes&quot;:{&quot;email&quot;:&quot;\u003cstring\u003e&quot;,&quot;phone_number&quot;:&quot;\u003cstring\u003e&quot;,&quot;external_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;first_name&quot;:&quot;\u003cstring\u003e&quot;,&quot;last_name&quot;:&quot;\u003cstring\u003e&quot;,&quot;organization&quot;:&quot;\u003cstring\u003e&quot;,&quot;locale&quot;:&quot;\u003cstring\u003e&quot;,&quot;title&quot;:&quot;\u003cstring\u003e&quot;,&quot;image&quot;:&quot;\u003cstring\u003e&quot;,&quot;created&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;updated&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;last_event_date&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;location&quot;:{&quot;address1&quot;:&quot;\u003cstring\u003e&quot;,&quot;address2&quot;:&quot;\u003cstring\u003e&quot;,&quot;city&quot;:&quot;\u003cstring\u003e&quot;,&quot;country&quot;:&quot;\u003cstring\u003e&quot;,&quot;latitude&quot;:&quot;\u003cstring\u003e&quot;,&quot;longitude&quot;:&quot;\u003cstring\u003e&quot;,&quot;region&quot;:&quot;\u003cstring\u003e&quot;,&quot;zip&quot;:&quot;\u003cstring\u003e&quot;,&quot;timezone&quot;:&quot;\u003cstring\u003e&quot;,&quot;ip&quot;:&quot;\u003cstring\u003e&quot;},&quot;properties&quot;:{},&quot;subscriptions&quot;:{&quot;email&quot;:{&quot;marketing&quot;:{&quot;can_receive_email_marketing&quot;:&quot;\u003cboolean\u003e&quot;,&quot;consent&quot;:&quot;\u003cstring\u003e&quot;,&quot;consent_timestamp&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;last_updated&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;method&quot;:&quot;\u003cstring\u003e&quot;,&quot;method_detail&quot;:&quot;&quot;,&quot;custom_method_detail&quot;:&quot;\u003cstring\u003e&quot;,&quot;double_optin&quot;:&quot;\u003cboolean\u003e&quot;,&quot;suppression&quot;:[{&quot;reason&quot;:&quot;\u003cstring\u003e&quot;,&quot;timestamp&quot;:&quot;\u003cdateTime\u003e&quot;},{&quot;reason&quot;:&quot;\u003cstring\u003e&quot;,&quot;timestamp&quot;:&quot;\u003cdateTime\u003e&quot;}],&quot;list_suppressions&quot;:[{&quot;list_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;reason&quot;:&quot;\u003cstring\u003e&quot;,&quot;timestamp&quot;:&quot;\u003cdateTime\u003e&quot;},{&quot;list_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;reason&quot;:&quot;\u003cstring\u003e&quot;,&quot;timestamp&quot;:&quot;\u003cdateTime\u003e&quot;}]}},&quot;sms&quot;:{&quot;marketing&quot;:{&quot;can_receive_sms_marketing&quot;:&quot;\u003cboolean\u003e&quot;,&quot;consent&quot;:&quot;\u003cstring\u003e&quot;,&quot;consent_timestamp&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;method&quot;:&quot;\u003cstring\u003e&quot;,&quot;last_updated&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;method_detail&quot;:&quot;&quot;}}},&quot;predictive_analytics&quot;:{&quot;historic_clv&quot;:&quot;\u003cnumber\u003e&quot;,&quot;predicted_clv&quot;:&quot;\u003cnumber\u003e&quot;,&quot;total_clv&quot;:&quot;\u003cnumber\u003e&quot;,&quot;historic_number_of_orders&quot;:&quot;\u003cinteger\u003e&quot;,&quot;predicted_number_of_orders&quot;:&quot;\u003cnumber\u003e&quot;,&quot;average_days_between_orders&quot;:&quot;\u003cnumber\u003e&quot;,&quot;average_order_value&quot;:&quot;\u003cnumber\u003e&quot;,&quot;churn_probability&quot;:&quot;\u003cnumber\u003e&quot;,&quot;expected_date_of_next_order&quot;:&quot;\u003cdateTime\u003e&quot;}},&quot;links&quot;:{&quot;self&quot;:&quot;\u003curi\u003e&quot;},&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;relationships&quot;:{&quot;lists&quot;:{&quot;links&quot;:{&quot;self&quot;:&quot;\u003curi\u003e&quot;,&quot;related&quot;:&quot;\u003curi\u003e&quot;}},&quot;segments&quot;:{&quot;links&quot;:{&quot;self&quot;:&quot;\u003curi\u003e&quot;,&quot;related&quot;:&quot;\u003curi\u003e&quot;}}}},{&quot;type&quot;:&quot;profile&quot;,&quot;attributes&quot;:{&quot;email&quot;:&quot;\u003cstring\u003e&quot;,&quot;phone_number&quot;:&quot;\u003cstring\u003e&quot;,&quot;external_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;first_name&quot;:&quot;\u003cstring\u003e&quot;,&quot;last_name&quot;:&quot;\u003cstring\u003e&quot;,&quot;organization&quot;:&quot;\u003cstring\u003e&quot;,&quot;locale&quot;:&quot;\u003cstring\u003e&quot;,&quot;title&quot;:&quot;\u003cstring\u003e&quot;,&quot;image&quot;:&quot;\u003cstring\u003e&quot;,&quot;created&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;updated&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;last_event_date&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;location&quot;:{&quot;address1&quot;:&quot;\u003cstring\u003e&quot;,&quot;address2&quot;:&quot;\u003cstring\u003e&quot;,&quot;city&quot;:&quot;\u003cstring\u003e&quot;,&quot;country&quot;:&quot;\u003cstring\u003e&quot;,&quot;latitude&quot;:&quot;\u003cstring\u003e&quot;,&quot;longitude&quot;:&quot;\u003cstring\u003e&quot;,&quot;region&quot;:&quot;\u003cstring\u003e&quot;,&quot;zip&quot;:&quot;\u003cstring\u003e&quot;,&quot;timezone&quot;:&quot;\u003cstring\u003e&quot;,&quot;ip&quot;:&quot;\u003cstring\u003e&quot;},&quot;properties&quot;:{},&quot;subscriptions&quot;:{&quot;email&quot;:{&quot;marketing&quot;:{&quot;can_receive_email_marketing&quot;:&quot;\u003cboolean\u003e&quot;,&quot;consent&quot;:&quot;\u003cstring\u003e&quot;,&quot;consent_timestamp&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;last_updated&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;method&quot;:&quot;\u003cstring\u003e&quot;,&quot;method_detail&quot;:&quot;&quot;,&quot;custom_method_detail&quot;:&quot;\u003cstring\u003e&quot;,&quot;double_optin&quot;:&quot;\u003cboolean\u003e&quot;,&quot;suppression&quot;:[{&quot;reason&quot;:&quot;\u003cstring\u003e&quot;,&quot;timestamp&quot;:&quot;\u003cdateTime\u003e&quot;},{&quot;reason&quot;:&quot;\u003cstring\u003e&quot;,&quot;timestamp&quot;:&quot;\u003cdateTime\u003e&quot;}],&quot;list_suppressions&quot;:[{&quot;list_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;reason&quot;:&quot;\u003cstring\u003e&quot;,&quot;timestamp&quot;:&quot;\u003cdateTime\u003e&quot;},{&quot;list_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;reason&quot;:&quot;\u003cstring\u003e&quot;,&quot;timestamp&quot;:&quot;\u003cdateTime\u003e&quot;}]}},&quot;sms&quot;:{&quot;marketing&quot;:{&quot;can_receive_sms_marketing&quot;:&quot;\u003cboolean\u003e&quot;,&quot;consent&quot;:&quot;\u003cstring\u003e&quot;,&quot;consent_timestamp&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;method&quot;:&quot;\u003cstring\u003e&quot;,&quot;last_updated&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;method_detail&quot;:&quot;&quot;}}},&quot;predictive_analytics&quot;:{&quot;historic_clv&quot;:&quot;\u003cnumber\u003e&quot;,&quot;predicted_clv&quot;:&quot;\u003cnumber\u003e&quot;,&quot;total_clv&quot;:&quot;\u003cnumber\u003e&quot;,&quot;historic_number_of_orders&quot;:&quot;\u003cinteger\u003e&quot;,&quot;predicted_number_of_orders&quot;:&quot;\u003cnumber\u003e&quot;,&quot;average_days_between_orders&quot;:&quot;\u003cnumber\u003e&quot;,&quot;average_order_value&quot;:&quot;\u003cnumber\u003e&quot;,&quot;churn_probability&quot;:&quot;\u003cnumber\u003e&quot;,&quot;expected_date_of_next_order&quot;:&quot;\u003cdateTime\u003e&quot;}},&quot;links&quot;:{&quot;self&quot;:&quot;\u003curi\u003e&quot;},&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;relationships&quot;:{&quot;lists&quot;:{&quot;links&quot;:{&quot;self&quot;:&quot;\u003curi\u003e&quot;,&quot;related&quot;:&quot;\u003curi\u003e&quot;}},&quot;segments&quot;:{&quot;links&quot;:{&quot;self&quot;:&quot;\u003curi\u003e&quot;,&quot;related&quot;:&quot;\u003curi\u003e&quot;}}}}],&quot;links&quot;:{&quot;self&quot;:&quot;\u003curi\u003e&quot;,&quot;first&quot;:&quot;\u003curi\u003e&quot;,&quot;last&quot;:&quot;\u003curi\u003e&quot;,&quot;prev&quot;:&quot;\u003curi\u003e&quot;,&quot;next&quot;:&quot;\u003curi\u003e&quot;}}