Get Profile

GET {{baseUrl}}/api/profiles/:id/

Get the profile with the given profile ID.

Rate limits:
Burst: 75/s
Steady: 700/m

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[list]stringFor more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
fields[profile]stringFor more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
fields[segment]stringFor more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
includestringFor more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships

HEADERS

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

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":{"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"}}}},"included":[{"type":"list","id":"\u003cstring\u003e","attributes":{"name":"\u003cstring\u003e","created":"\u003cdateTime\u003e","updated":"\u003cdateTime\u003e","opt_in_process":"single_opt_in"},"links":{"self":"\u003curi\u003e"}},{"type":"list","id":"\u003cstring\u003e","attributes":{"name":"\u003cstring\u003e","created":"\u003cdateTime\u003e","updated":"\u003cdateTime\u003e","opt_in_process":"double_opt_in"},"links":{"self":"\u003curi\u003e"}}]}