Public Klaviyo API Reference
CampaignMessageCampaign
The related campaign
Parameter
<message_id> (optional): The list id
<message_table> (optional): The table name with message data
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
|---|---|---|
message_id | string | The message id |
type | string | Campaign |
id | string | The campaign id |
name | string | The campaign name |
status | string | The campaign status |
archived | boolean | Whether the campaign has been archived or not |
send_options_use_smart_sending | boolean | Use smart sending |
send_options_ignore_unsubscribes | boolean | Ignore unsubscribes |
tracking_options_is_add_utm | boolean | Whether the campaign needs UTM parameters |
tracking_options_is_tracking_clicks | boolean | Whether the campaign is tracking click events |
tracking_options_is_tracking_opens | boolean | Whether the campaign is tracking open events |
send_strategy_method | string | Describes the shape of the options object |
send_strategy_options_static_datetime | timestamp | The time to send at |
send_strategy_options_static_is_local | boolean | If the campaign should be sent with local recipient timezone send or statically sent at the given time |
send_strategy_options_static_send_past_recipients_immediately | boolean | Determines if we should send to local recipient timezone if the given time has passed |
created_at | timestamp | The datetime when the campaign was created |
scheduled_at | timestamp | The datetime when the campaign was scheduled for future sending |
updated_at | timestamp | The datetime when the campaign was last updated |
send_time | timestamp | The datetime when the campaign will be / was sent or None if not yet scheduled by a send_job |
included_audiences | string | A list of included audiences |
excluded_audiences | string | A list of excluded audiences |
CampaignMessageTemplate
The related template
Parameter
<message_id> (optional): The message id
<message_table> (optional): The table name with message data
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
|---|---|---|
message_id | string | The message id |
type | string | Template |
id | string | The ID of template |
name | string | The name of the template |
editor_type | string | Editor type |
html | string | The rendered HTML of the template |
text | string | The template plain_text |
created | timestamp | The datetime when the template was created |
updated | timestamp | The datetime when the template was last updated |
CampaignRecipientEstimation
The estimated recipient count for a campaign
Parameter
<campaign_id> (optional): The list id
<campaign_table> (optional): The table name with campaign data
<channel_filter> (optional): Channel filter: sms or email
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
|---|---|---|
campaign_id | string | The campaign id |
type | string | Campaign recipient estimation |
estimated_recipient_count | integer | The estimated number of unique recipients the campaign will send to |
Campaigns
Campaigns
Parameter
<channel_filter> (required): Channel filter: sms or email
<initial_date> (optional): Earliest datetime to retrieve data
<campaign_id> (optional): Campaign id
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
|---|---|---|
type | string | Campaign |
id | string | The campaign id |
name | string | The campaign name |
status | string | The campaign status |
archived | boolean | Whether the campaign has been archived or not |
send_options_use_smart_sending | boolean | Use smart sending |
send_options_ignore_unsubscribes | boolean | Ignore unsubscribes |
tracking_options_is_add_utm | boolean | Whether the campaign needs UTM parameters |
tracking_options_is_tracking_clicks | boolean | Whether the campaign is tracking click events |
tracking_options_is_tracking_opens | boolean | Whether the campaign is tracking open events |
send_strategy_method | string | Describes the shape of the options object |
send_strategy_options_static_datetime | timestamp | The time to send at |
send_strategy_options_static_is_local | boolean | If the campaign should be sent with local recipient timezone send or statically sent at the given time |
send_strategy_options_static_send_past_recipients_immediately | boolean | Determines if we should send to local recipient timezone if the given time has passed |
options_throttled_datetime | timestamp | Throttled method: the time to send at |
options_throttled_throttle_percentage | integer | Throttled method: the percentage of recipients per hour to send to |
options_sto_date | date | The day to send on |
created_at | timestamp | The datetime when the campaign was created |
scheduled_at | timestamp | The datetime when the campaign was scheduled for future sending |
updated_at | timestamp | The datetime when the campaign was last updated |
send_time | timestamp | The datetime when the campaign will be / was sent or None if not yet scheduled by a send_job |
included_audiences | string | A list of included audiences |
excluded_audiences | string | A list of excluded audiences |
CatalogItems
Catalog Items
Parameter
<catalog_item_id> (optional): Flow id
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
|---|---|---|
type | string | The type of catalog item |
id | string | The catalog item id |
external_id | string | The external item id |
title | string | The title of catalog item |
description | string | The description of catalog item |
url | string | The url of catalog item |
image_full_url | string | The image full url of catalog item |
image_thumbnail_url | string | The image thumbnail url of catalog item |
created | timestamp | Timestamp of when a flow is created |
updated | timestamp | Timestamp of when a flow is updated |
published | boolean | Published |
links | string | Links |
Events
Events
Parameter
<initial_date> (required): Earliest datetime to retrieve data
<event_id> (optional): Event id
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
|---|---|---|
type | string | The type of event |
id | string | The event id |
metric_id | string | The metric id |
profile_id | string | The profile id |
attributes_timestamp | timestamp | Attributes timestamp |
form_id | string | Form id |
form_version_id | string | Form version id |
form_type | string | Form type |
device_type | string | Device type |
page_url | string | Page url |
event_id | string | $event id |
attributes_datetime | timestamp | Attributes datetime |
attributes_uuid | string | UUID |
links | string | Links |
FlowActions
Flow Actions
Parameter
<flow_id> (optional): Flow id
<flow_table> (optional): Table with id of the flows
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
|---|---|---|
flow_id | string | Flow id |
type | string | The type of flow action |
id | string | The flow action id |
action_type | string | The action type |
status | string | The status of flow action |
created | timestamp | Timestamp of when a flow action is created |
updated | timestamp | Timestamp of when a flow action is updated |
send_options_use_smart_sending | boolean | Send option - use smart sending |
send_options_is_transactional | boolean | Send option - is transactional |
render_options_shorten_links | boolean | Render option - options shorten links |
render_options_add_org_prefix | boolean | Render option - add org prefix |
render_options_add_info_link | boolean | Render option - add info link |
render_options_add_opt_out_language | boolean | Render option - add opt out language |
links | string | Links |
Flows
Flows
Parameter
<flow_id> (optional): Flow id
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
|---|---|---|
type | string | The type of flow |
id | string | The flow id |
name | string | The name of flow |
status | string | The status of flow |
archived | boolean | Indicates whether the flow was archived |
created | timestamp | Timestamp of when a flow is created |
updated | timestamp | Timestamp of when a flow is updated |
trigger_type | string | The trigger type |
links | string | Links |
ListProfiles
All profiles within a lists
Parameter
<list_id> (optional): The list id
<list_table> (optional): The table name with list data
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
|---|---|---|
list_id | string | The list id |
profile_id | string | The profile id |
ListTags
All tags associated with the lists
Parameter
<list_id> (optional): The list id
<list_table> (optional): The table name with list data
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
|---|---|---|
list_id | string | The list id |
id | string | The tag id |
type | string | Tag |
name | string | The tag name |
created | timestamp | Creation time |
updated | timestamp | Last updated time |
tag_group_id | string | The tag group id |
Lists
Lists in an account
Parameter
<list_id> (optional): The list id
<initial_date> (optional): Earliest datetime to retrieve data
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
|---|---|---|
list_id | string | The list id |
type | string | Metric |
list_name | string | The list name |
created | timestamp | Creation time |
updated | timestamp | Last updated time |
MessagesForFlowAction
Messages for flow action
Parameter
<flow_action_id> (optional): Flow id
<flow_action_table> (optional): Table with id of the flows
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
|---|---|---|
flow_action_id | string | Flow id |
type | string | The type of flow action |
id | string | The flow action id |
name | string | The flow action name |
channel | string | The channel of flow action |
content_subject | string | Subject |
content_preview_text | string | Preview text |
content_from_email | string | From email |
content_from_name | string | From name |
created | timestamp | Timestamp of when a flow action is created |
updated | timestamp | Timestamp of when a flow action is updated |
links | string | Links |
Metrics
Metrics in Klaviyo
Parameter
<metric_id> (optional): Metric Id
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
|---|---|---|
id | string | The Metric ID |
type | string | Metric |
name | string | The name of the metric |
created | timestamp | Creation time |
updated | timestamp | Last updated time |
integration_category | string | The integration category associated with the event |
integration_id | string | The integration id associated with the event |
integration_name | string | The integration name associated with the event |
integration_object | string | The integration object associated with the event |
ProfileLists
List memberships for a profile with the given profile ID
Parameter
<profile_id> (optional): Profile id
<profile_table> (optional): Table with id of the Profiles
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
|---|---|---|
type | string | The type of list |
id | string | The list id |
name | string | The name of list |
created | timestamp | Timestamp of when a list is created |
updated | timestamp | Timestamp of when a list is updated |
links | string | Links |
Profiles
Profiles
Parameter
<profile_id> (optional): Flow id
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
|---|---|---|
type | string | The type of profile |
id | string | The profile id |
string | ||
phone_number | string | Phone number |
external_id | string | The external id |
anonymous_id | string | The anonymous id |
first_name | string | First name |
last_name | string | Last name |
organization | string | Organization |
title | string | Title |
image | string | Image |
created | timestamp | Timestamp of when a profile is created |
updated | timestamp | Timestamp of when a profile is updated |
last_event_date | timestamp | Last event date |
location_address1 | string | Location - address1 |
location_address2 | string | Location - address2 |
location_city | string | Location - city |
location_country | string | Location - country |
location_latitude | string | Location - latitude |
location_longitude | string | Location - longitude |
location_region | string | Location - region |
location_zip | string | Location - zip |
location_timezone | string | Location - timezone |
links | string | Links |
SegmentProfiles
All profiles Id within the given segment Id
Parameter
<segment_id> (optional): Segment id
<segment_table> (optional): Table with id of the segments
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
|---|---|---|
segment_id | string | The segment id |
profile_id | string | The profile id |
Segments
Segments
Parameter
<segment_id> (optional): Segment id
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
|---|---|---|
type | string | The type of segment |
id | string | The segment id |
name | string | The name of segment |
created | timestamp | Timestamp of when a segment is created |
updated | timestamp | Timestamp of when a segment is updated |
links | string | Links |
Templates
Templates
Parameter
<template_id> (optional): Template id
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
|---|---|---|
type | string | The type of template |
id | string | The template id |
company_id | string | The company id |
name | string | The name of template |
editor_type | string | The editor type |
created | timestamp | Timestamp of when a template is created |
updated | timestamp | Timestamp of when a template is updated |
links | string | Links |