Klaviyo icon

Klaviyo

Interact with the Klaviyo API
Join our community

Actions17

Overview

This node interacts with the Klaviyo API to retrieve multiple profile records. It is designed to fetch a paginated list of user profiles stored in Klaviyo, allowing filtering, sorting, and selection of specific fields. This operation is useful for scenarios such as exporting user data, syncing profiles with other systems, or analyzing customer information.

Practical examples include:

  • Retrieving all profiles created after a certain date.
  • Fetching profiles sorted by their email addresses.
  • Getting a subset of profile fields like email, phone number, and location for targeted marketing campaigns.

Properties

Name Meaning
Page Cursor A string cursor used for pagination to specify the starting point of the page to retrieve.
Page Size Number of profiles to return per request. Must be between 1 and 100.
Sort Defines the order in which profiles are returned. Options include sorting by id, email, creation date, or update date, each either ascending or descending.
Filters Allows filtering profiles based on field values or dates. Supports multiple filters:
- Field filter: Filter by profile fields (id, email, phone number, external ID, or a special key) using operators "equals" or "any" (comma-separated list).
- Date filter: Filter by creation or update date using "greater-than" or "less-than" operators.
Query Parameters Select which profile fields to include in the response. Multiple fields can be selected such as email, phone number, external ID, first name, last name, organization, locale, title, image, created/updated timestamps, last event date, location details, and custom properties.

Output

The node outputs JSON data containing an array of profile objects matching the query parameters. Each profile object includes the requested fields such as email, phone number, names, location details, timestamps, and any custom properties specified.

If binary data were supported, it would typically represent files or images associated with profiles, but this node focuses on JSON profile data only.

Dependencies

  • Requires an API key credential for authenticating with the Klaviyo API.
  • The node uses the base URL https://a.klaviyo.com/api and expects JSON:API formatted requests and responses.
  • No additional external dependencies beyond the configured API key and network access to Klaviyo.

Troubleshooting

  • Invalid API Key or Authentication Errors: Ensure the API key credential is correctly configured and has sufficient permissions.
  • Pagination Issues: If no results are returned, verify the Page Cursor value is correct or reset it to start from the beginning.
  • Filter Syntax Errors: Filters must follow the expected format; incorrect operators or malformed values may cause errors.
  • Exceeded Page Size Limits: The Page Size must be between 1 and 100; values outside this range will cause validation errors.
  • Empty Results: Could indicate no profiles match the filters or query parameters; try broadening filters or removing them to test.

Links and References

Discussion