Get Event Profile
GET {{baseUrl}}/api/events/:id/profile/
Get the profile associated with an event with the given event ID.
Rate limits:
Burst: 350/s
Steady: 3500/m
Scopes:
events: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: 'subscriptions', 'predictive_analytics' | |
fields[profile] | string | For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
revision | string | (Required) API endpoint revision (format: YYYY-MM-DD[.suffix]) | |
Accept | string |
RESPONSES
status: OK
{"data":{"type":"profile","attributes":{"email":"\u003cstring\u003e","phone_number":"\u003cstring\u003e","external_id":"\u003cstring\u003e","first_name":"\u003cstring\u003e","last_name":"\u003cstring\u003e","organization":"\u003cstring\u003e","locale":"\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","ip":"\u003cstring\u003e"},"properties":{},"subscriptions":{"email":{"marketing":{"can_receive_email_marketing":"\u003cboolean\u003e","consent":"\u003cstring\u003e","consent_timestamp":"\u003cdateTime\u003e","last_updated":"\u003cdateTime\u003e","method":"\u003cstring\u003e","method_detail":"","custom_method_detail":"\u003cstring\u003e","double_optin":"\u003cboolean\u003e","suppression":[{"reason":"\u003cstring\u003e","timestamp":"\u003cdateTime\u003e"},{"reason":"\u003cstring\u003e","timestamp":"\u003cdateTime\u003e"}],"list_suppressions":[{"list_id":"\u003cstring\u003e","reason":"\u003cstring\u003e","timestamp":"\u003cdateTime\u003e"},{"list_id":"\u003cstring\u003e","reason":"\u003cstring\u003e","timestamp":"\u003cdateTime\u003e"}]}},"sms":{"marketing":{"can_receive_sms_marketing":"\u003cboolean\u003e","consent":"\u003cstring\u003e","consent_timestamp":"\u003cdateTime\u003e","method":"\u003cstring\u003e","last_updated":"\u003cdateTime\u003e","method_detail":""}}},"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"},"id":"\u003cstring\u003e","relationships":{"lists":{"links":{"self":"\u003curi\u003e","related":"\u003curi\u003e"}},"segments":{"links":{"self":"\u003curi\u003e","related":"\u003curi\u003e"}}}}}