Get List Profiles
GET {{baseUrl}}/api/lists/:list_id/profiles/
Get all profiles within a list with the given list ID.
Filter to request a subset of all profiles. Profiles can be filtered by email, phone_number, and push_token fields.
Rate limits:
Burst: 10/s
Steady: 150/m
Scopes:
list:read
profiles:read
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
additional-fields[profile] | string | Request additional fields not included by default in the response. Supported values: 'predictive_analytics' | |
fields[profile] | string | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | |
filter | string | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>email: any<br>phone_number: any<br>push_token: any<br>_kx: equals | |
page[cursor] | string | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination | |
page[size] | number | Default: 20. Min: 1. Max: 100. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
revision | string | (Required) API endpoint revision (format: YYYY-MM-DD[.suffix]) | |
Accept | string |
RESPONSES
status: OK
{"data":[{"type":"profile","id":"\u003cstring\u003e","attributes":{"email":"\u003cstring\u003e","phone_number":"\u003cstring\u003e","external_id":"\u003cstring\u003e","first_name":"\u003cstring\u003e","last_name":"\u003cstring\u003e","organization":"\u003cstring\u003e","title":"\u003cstring\u003e","image":"\u003cstring\u003e","created":"\u003cdateTime\u003e","updated":"\u003cdateTime\u003e","last_event_date":"\u003cdateTime\u003e","location":{"address1":"\u003cstring\u003e","address2":"\u003cstring\u003e","city":"\u003cstring\u003e","country":"\u003cstring\u003e","latitude":"\u003cstring\u003e","longitude":"\u003cstring\u003e","region":"\u003cstring\u003e","zip":"\u003cstring\u003e","timezone":"\u003cstring\u003e"},"properties":{},"subscriptions":{"email":{"marketing":{"consent":"\u003cstring\u003e","method":"\u003cstring\u003e","timestamp":"\u003cdateTime\u003e","method_detail":"\u003cstring\u003e","custom_method_detail":"\u003cstring\u003e","double_optin":"\u003cboolean\u003e","suppressions":{"reason":"\u003cstring\u003e","timestamp":"\u003cdateTime\u003e"},"list_suppressions":{"list_id":"\u003cstring\u003e","reason":"\u003cstring\u003e","timestamp":"\u003cdateTime\u003e"}}},"sms":{"marketing":{"consent":"\u003cstring\u003e","timestamp":"\u003cdateTime\u003e","method":"\u003cstring\u003e","method_detail":"\u003cstring\u003e"}}},"predictive_analytics":{"historic_clv":"\u003cnumber\u003e","predicted_clv":"\u003cnumber\u003e","total_clv":"\u003cnumber\u003e","historic_number_of_orders":"\u003cinteger\u003e","predicted_number_of_orders":"\u003cnumber\u003e","average_days_between_orders":"\u003cnumber\u003e","average_order_value":"\u003cnumber\u003e","churn_probability":"\u003cnumber\u003e","expected_date_of_next_order":"\u003cdateTime\u003e"}},"links":{"self":"\u003curi\u003e"},"relationships":{"lists":{"data":[{"type":"list","id":"\u003cstring\u003e"},{"type":"list","id":"\u003cstring\u003e"}],"links":{"self":"\u003curi\u003e","related":"\u003curi\u003e"}},"segments":{"data":[{"type":"segment","id":"\u003cstring\u003e"},{"type":"segment","id":"\u003cstring\u003e"}],"links":{"self":"\u003curi\u003e","related":"\u003curi\u003e"}}}},{"type":"profile","id":"\u003cstring\u003e","attributes":{"email":"\u003cstring\u003e","phone_number":"\u003cstring\u003e","external_id":"\u003cstring\u003e","first_name":"\u003cstring\u003e","last_name":"\u003cstring\u003e","organization":"\u003cstring\u003e","title":"\u003cstring\u003e","image":"\u003cstring\u003e","created":"\u003cdateTime\u003e","updated":"\u003cdateTime\u003e","last_event_date":"\u003cdateTime\u003e","location":{"address1":"\u003cstring\u003e","address2":"\u003cstring\u003e","city":"\u003cstring\u003e","country":"\u003cstring\u003e","latitude":"\u003cstring\u003e","longitude":"\u003cstring\u003e","region":"\u003cstring\u003e","zip":"\u003cstring\u003e","timezone":"\u003cstring\u003e"},"properties":{},"subscriptions":{"email":{"marketing":{"consent":"\u003cstring\u003e","method":"\u003cstring\u003e","timestamp":"\u003cdateTime\u003e","method_detail":"\u003cstring\u003e","custom_method_detail":"\u003cstring\u003e","double_optin":"\u003cboolean\u003e","suppressions":{"reason":"\u003cstring\u003e","timestamp":"\u003cdateTime\u003e"},"list_suppressions":{"list_id":"\u003cstring\u003e","reason":"\u003cstring\u003e","timestamp":"\u003cdateTime\u003e"}}},"sms":{"marketing":{"consent":"\u003cstring\u003e","timestamp":"\u003cdateTime\u003e","method":"\u003cstring\u003e","method_detail":"\u003cstring\u003e"}}},"predictive_analytics":{"historic_clv":"\u003cnumber\u003e","predicted_clv":"\u003cnumber\u003e","total_clv":"\u003cnumber\u003e","historic_number_of_orders":"\u003cinteger\u003e","predicted_number_of_orders":"\u003cnumber\u003e","average_days_between_orders":"\u003cnumber\u003e","average_order_value":"\u003cnumber\u003e","churn_probability":"\u003cnumber\u003e","expected_date_of_next_order":"\u003cdateTime\u003e"}},"links":{"self":"\u003curi\u003e"},"relationships":{"lists":{"data":[{"type":"list","id":"\u003cstring\u003e"},{"type":"list","id":"\u003cstring\u003e"}],"links":{"self":"\u003curi\u003e","related":"\u003curi\u003e"}},"segments":{"data":[{"type":"segment","id":"\u003cstring\u003e"},{"type":"segment","id":"\u003cstring\u003e"}],"links":{"self":"\u003curi\u003e","related":"\u003curi\u003e"}}}}],"links":{"self":"\u003curi\u003e","first":"\u003curi\u003e","last":"\u003curi\u003e","prev":"\u003curi\u003e","next":"\u003curi\u003e"}}