Klaviyo API

Getting access, Developing, Testing

Back to Klaviyo

Get Profiles

Get all profiles in an account.\nProfiles can be sorted by the following fields in ascending and descending order: id, created, updated, email\nYou 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: 10/s
Steady: 150/m\n\nScopes:\nProfiles Read

Input

type: object properties: parameters: type: object properties: additional-fields[profile]: type: array items: type: string enum: - predictive_analytics description: >- Request additional fields not included by default in the response. Supported values: 'predictive_analytics' fields[profile]: type: array items: type: string enum: - email - phone_number - external_id - first_name - last_name - organization - title - image - created - updated - last_event_date - location - location.address1 - location.address2 - location.city - location.country - location.latitude - location.longitude - location.region - location.zip - location.timezone - properties - subscriptions - subscriptions.email - subscriptions.email.marketing - subscriptions.email.marketing.consent - subscriptions.email.marketing.timestamp - subscriptions.email.marketing.method - subscriptions.email.marketing.method_detail - subscriptions.email.marketing.custom_method_detail - subscriptions.email.marketing.double_optin - subscriptions.email.marketing.suppressions - subscriptions.email.marketing.suppressions.reason - subscriptions.email.marketing.suppressions.timestamp - subscriptions.email.marketing.list_suppressions - subscriptions.email.marketing.list_suppressions.list_id - subscriptions.email.marketing.list_suppressions.reason - subscriptions.email.marketing.list_suppressions.timestamp - subscriptions.sms - subscriptions.sms.marketing - subscriptions.sms.marketing.consent - subscriptions.sms.marketing.timestamp - subscriptions.sms.marketing.method - subscriptions.sms.marketing.method_detail - predictive_analytics - predictive_analytics.historic_clv - predictive_analytics.predicted_clv - predictive_analytics.total_clv - predictive_analytics.historic_number_of_orders - predictive_analytics.predicted_number_of_orders - predictive_analytics.average_days_between_orders - predictive_analytics.average_order_value - predictive_analytics.churn_probability - predictive_analytics.expected_date_of_next_order description: >- For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets filter: type: string description: >- For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering<br>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` page[cursor]: type: string description: >- For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination sort: type: string enum: - created - '-created' - email - '-email' - id - '-id' - updated - '-updated' description: >- For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting revision: type: string default: '2023-02-22' description: 'API endpoint revision (format: YYYY-MM-DD[.suffix])' page[size]: type: integer description: The number of results to return per page. Default = 20. Max = 100 required: - revision title: Parameters

Output

type: object required: - data - links properties: data: type: array items: type: object required: - type - id - attributes - links properties: type: type: string enum: - profile id: type: string example: 01GDDKASAP8TKDDA2GRZDSVP4H description: >- Primary key that uniquely identifies this profile. Generated by Klaviyo. attributes: type: object properties: email: type: string example: [email protected] description: Individual's email address phone_number: type: string example: '+15005550006' description: Individual's phone number in E.164 format external_id: type: string example: 63f64a2b-c6bf-40c7-b81f-bed08162edbe description: >- A unique identifier used by customers to associate Klaviyo profiles with profiles in an external system, such as a point-of-sale system. Format varies based on the external system. first_name: type: string example: Sarah description: Individual's first name last_name: type: string example: Mason description: Individual's last name organization: type: string example: Klaviyo description: >- Name of the company or organization within the company for whom the individual works title: type: string example: Engineer description: Individual's job title image: type: string example: >- https://images.pexels.com/photos/3760854/pexels-photo-3760854.jpeg description: URL pointing to the location of a profile image created: type: string format: date-time example: '2022-11-08T00:00:00' description: >- Date and time when the profile was created, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm) updated: type: string format: date-time example: '2022-11-08T00:00:00' description: >- Date and time when the profile was last updated, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm) last_event_date: type: string format: date-time example: '2022-11-08T00:00:00' description: >- Date and time of the most recent event the triggered an update to the profile, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm) location: type: object properties: address1: type: string example: 89 E 42nd St description: First line of street address address2: type: string example: 1st floor description: Second line of street address city: type: string example: New York description: City name country: type: string example: United States description: Country name latitude: oneOf: - type: string - type: number example: '40.7128' description: >- Latitude coordinate. We recommend providing a precision of four decimal places. longitude: oneOf: - type: string - type: number example: '74.0060' description: >- Longitude coordinate. We recommend providing a precision of four decimal places. region: type: string example: NY description: Region within a country, such as state or province zip: type: string example: '10017' description: Zip code timezone: type: string example: America/New_York description: >- Time zone name. We recommend using time zones from the IANA Time Zone Database. properties: type: object example: pseudonym: Dr. Octopus description: >- An object containing key/value pairs for any custom properties assigned to this profile subscriptions: type: object properties: email: type: object properties: marketing: type: object required: - consent - method properties: consent: type: string example: SUBSCRIBED description: The consent status for email marketing. timestamp: type: string format: date-time example: '2023-02-21T20:07:38+00:00' description: >- The timestamp when consent record or updated for email marketing, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm). method: type: string example: PREFERENCE_PAGE description: >- The method by which the profile was subscribed to email marketing. method_detail: type: string example: mydomain.com/signup description: >- Additional details about the method by which the profile was subscribed to SMS marketing. This may be empty if no details were provided. custom_method_detail: type: string example: marketing drive description: >- Additional detail provided by the caller when the profile was subscribed. This may be empty if no details were provided. double_optin: type: boolean example: 'True' description: >- Whether the profile was subscribed to email marketing using a double opt-in. suppressions: type: object required: - reason - timestamp properties: reason: type: string example: HARD_BOUNCE description: >- The reason the profile was suppressed from the list. timestamp: type: string format: date-time example: '2023-02-21T20:07:38+00:00' description: >- The timestamp when the profile was suppressed from the list, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm). list_suppressions: type: object required: - list_id - reason - timestamp properties: list_id: type: string example: Y6nRLr description: The ID of list to which the suppression applies. reason: type: string example: USER_SUPPRESSED description: >- The reason the profile was suppressed from the list. timestamp: type: string format: date-time example: '2023-02-21T20:07:38+00:00' description: >- The timestamp when the profile was suppressed from the list, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm). sms: type: object properties: marketing: type: object required: - consent - timestamp - method - method_detail properties: consent: type: string example: SUBSCRIBED description: The consent status for SMS marketing. timestamp: type: string format: date-time example: '2023-02-21T20:07:38+00:00' description: >- The timestamp when consent record or updated for SMS marketing, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm). method: type: string example: TEXT description: >- The method by which the profile was subscribed to SMS marketing. method_detail: type: string example: JOIN description: >- Additional details about the method which the profile was subscribed to SMS marketing. This may be empty if no details were provided. predictive_analytics: type: object properties: historic_clv: type: number example: 93.87 description: Total value of all historically placed orders predicted_clv: type: number example: 27.24 description: Predicted value of all placed orders in the next 365 days total_clv: type: number example: 121.11 description: Sum of historic and predicted CLV historic_number_of_orders: type: integer example: 2 description: Number of already placed orders predicted_number_of_orders: type: number example: 0.54 description: Predicted number of placed orders in the next 365 days average_days_between_orders: type: number example: 189 description: >- Average number of days between orders (None if only one order has been placed) average_order_value: type: number example: 46.94 description: Average value of placed orders churn_probability: type: number example: 0.89 description: Probability the customer has churned expected_date_of_next_order: type: string format: date-time example: '2022-11-08T00:00:00' description: >- Expected date of next order, as calculated at the time of their most recent order links: type: object required: - self properties: self: type: string format: uri relationships: type: object properties: lists: type: object required: - data properties: data: type: array items: type: object required: - type - id properties: type: type: string enum: - list id: type: string segments: type: object required: - data properties: data: type: array items: type: object required: - type - id properties: type: type: string enum: - segment id: type: string links: type: object required: - self properties: self: type: string format: uri first: type: string format: uri last: type: string format: uri prev: type: string format: uri next: type: string format: uri included: type: array items: oneOf: - type: object required: - type - id - attributes - links properties: type: type: string enum: - list id: type: string example: Y6nRLr description: >- Primary key that uniquely identifies this list. Generated by Klaviyo. attributes: type: object properties: name: type: string example: Newsletter description: A helpful name to label the list created: type: string format: date-time example: '2022-11-08T00:00:00' description: >- Date and time when the list was created, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm) updated: type: string format: date-time example: '2022-11-08T00:00:00' description: >- Date and time when the list was last updated, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm) links: type: object required: - self properties: self: type: string format: uri - type: object required: - type - id - attributes - links properties: type: type: string enum: - segment id: type: string attributes: type: object properties: name: type: string example: Repeat Purchasers description: 'A helpful name to label the segment ' created: type: string format: date-time example: '2022-11-08T00:00:00' description: >- Date and time when the segment was created, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm) updated: type: string format: date-time example: '2022-11-08T00:00:00' description: >- Date and time when the segment was last updated, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm) links: type: object required: - self properties: self: type: string format: uri