{
"opencollection": "1.0.0",
"info": {
"name": "Klaviyo Accounts Client API",
"version": "2026-04-15"
},
"request": {
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"items": [
{
"info": {
"name": "Client",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get Client Review Values Reports",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://a.klaviyo.com/client/review-values-reports",
"headers": [
{
"name": "revision",
"value": ""
}
],
"params": [
{
"name": "company_id",
"value": "",
"type": "query",
"description": "Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details."
},
{
"name": "fields[review-values-report]",
"value": "",
"type": "query",
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets"
},
{
"name": "filter",
"value": "",
"type": "query",
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
`product_external_ids`: `any`, `equals`"
},
{
"name": "group_by",
"value": "",
"type": "query",
"description": "group by value for this report"
},
{
"name": "page[cursor]",
"value": "",
"type": "query",
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination"
},
{
"name": "page[size]",
"value": "",
"type": "query",
"description": "Default: 20. Min: 1. Max: 100."
},
{
"name": "statistics",
"value": "",
"type": "query",
"description": "list of statistics to calculate for this report"
},
{
"name": "timeframe",
"value": "",
"type": "query",
"description": "timeframe window for value report"
}
]
},
"docs": "Get all reviews values reports in an account.
*Rate limits*:
Burst: `10/s`
Steady: `150/m`"
},
{
"info": {
"name": "Get Client Reviews",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://a.klaviyo.com/client/reviews",
"headers": [
{
"name": "revision",
"value": ""
}
],
"params": [
{
"name": "company_id",
"value": "",
"type": "query",
"description": "Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details."
},
{
"name": "fields[review]",
"value": "",
"type": "query",
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets"
},
{
"name": "filter",
"value": "",
"type": "query",
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
`status`: `equals`
`review_type`: `equals`
`rating`: `any`, `equals`, `greater-or-equal`, `less-or-equal`
`id`: `any`, `equals`
`content`: `contains`
`smart_quote`: `has`
`public_reply`: `has`
`verified`: `equals`
`incentivized`: `equals`
`edited`: `equals`
`media`: `has`
`created`: `greater-or-equal`, `less-or-equal`
`updated`: `greater-or-equal`, `less-or-equal`"
},
{
"name": "page[cursor]",
"value": "",
"type": "query",
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination"
},
{
"name": "page[size]",
"value": "",
"type": "query",
"description": "Default: 20. Min: 1. Max: 100."
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting"
}
]
},
"docs": "Get all reviews. This endpoint is for client-side environments only, for server-side use, refer to https://developers.klaviyo.com/en/reference/get_reviews
*Rate limits*:
Burst: `10/s`
Steady: `150/m`"
},
{
"info": {
"name": "Create Client Review",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://a.klaviyo.com/client/reviews",
"headers": [
{
"name": "revision",
"value": ""
}
],
"params": [
{
"name": "company_id",
"value": "",
"type": "query",
"description": "Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a review with the given ID. This endpoint is for client-side environments only.
*Rate limits*:
Burst: `10/s`
Steady: `150/m`"
},
{
"info": {
"name": "Get Client Geofences",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://a.klaviyo.com/client/geofences",
"headers": [
{
"name": "X-Klaviyo-API-Filters",
"value": ""
},
{
"name": "revision",
"value": ""
}
],
"params": [
{
"name": "company_id",
"value": "",
"type": "query",
"description": "Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details."
},
{
"name": "fields[geofence]",
"value": "",
"type": "query",
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets"
},
{
"name": "page[cursor]",
"value": "",
"type": "query",
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination"
},
{
"name": "page[size]",
"value": "",
"type": "query",
"description": "Default: 20. Min: 1. Max: 100."
}
]
},
"docs": "Get all geofences in an account.\n\nReturns a paginated list of all geofences for the specified company.\nThis is the GA API endpoint designed for mobile SDK consumption.\nNo authentication required.\n\nReturns a maximum of 100 results per page (default 20).\n\nThis API supports filtering via header instead of query param. Provide\n`X-Klaviyo-API-Filters` header to filter geofences. We don't use regular\nquery param filters here because lat and long are sensitive information.\n\nSupported filters:\n- `lat` ("
},
{
"info": {
"name": "Create Client Subscription",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://a.klaviyo.com/client/subscriptions",
"headers": [
{
"name": "revision",
"value": ""
}
],
"params": [
{
"name": "company_id",
"value": "",
"type": "query",
"description": "Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates a subscription and consent record for email and/or SMS channels based on the provided `email` and `phone_number` attributes, respectively. One of either `email` or `phone_number` must be provided.\n\nThis endpoint is specifically designed to be called from publicly-browseable, client-side environments only and requires a [public API key (site ID)](https://www.klaviyo.com/settings/account/api-keys). Never use a private API key with our client-side endpoints.\n\nDo not use this endpoint from s"
},
{
"info": {
"name": "Create or Update Client Push Token",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://a.klaviyo.com/client/push-tokens",
"headers": [
{
"name": "revision",
"value": ""
}
],
"params": [
{
"name": "company_id",
"value": "",
"type": "query",
"description": "Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create or update a push token.\n\nThis endpoint is specifically designed to be called from our mobile SDKs ([iOS](https://github.com/klaviyo/klaviyo-swift-sdk) and [Android](https://github.com/klaviyo/klaviyo-android-sdk)) and requires a [public API key (site ID)](https://www.klaviyo.com/settings/account/api-keys). Never use a private API key with our client-side endpoints.\nYou must have push notifications enabled to use this endpoint.\n\nTo migrate push tokens from another platform to Klaviyo, plea"
},
{
"info": {
"name": "Unregister Client Push Token",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://a.klaviyo.com/client/push-token-unregister",
"headers": [
{
"name": "revision",
"value": ""
}
],
"params": [
{
"name": "company_id",
"value": "",
"type": "query",
"description": "Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Unregister a push token.\n\nThis endpoint is specifically designed to be called from our mobile SDKs ([iOS](https://github.com/klaviyo/klaviyo-swift-sdk) and [Android](https://github.com/klaviyo/klaviyo-android-sdk)) and requires a [public API key (site ID)](https://www.klaviyo.com/settings/account/api-keys). Never use a private API key with our client-side endpoints.\nYou must have push notifications enabled to use this endpoint.
*Rate limits*:
Burst: `10/s`
Steady: `150/m`"
},
{
"info": {
"name": "Create Client Event",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://a.klaviyo.com/client/events",
"headers": [
{
"name": "revision",
"value": ""
}
],
"params": [
{
"name": "company_id",
"value": "",
"type": "query",
"description": "Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a new event to track a profile's activity.\n\nThis endpoint is specifically designed to be called from publicly-browseable, client-side environments only and requires a [public API key (site ID)](https://www.klaviyo.com/settings/account/api-keys). Never use a private API key with our client-side endpoints.\n\nDo not use this endpoint from server-side applications.\nTo create events from server-side applications, instead use [POST /api/events](https://developers.klaviyo.com/en/reference/create_"
},
{
"info": {
"name": "Create or Update Client Profile",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://a.klaviyo.com/client/profiles",
"headers": [
{
"name": "revision",
"value": ""
}
],
"params": [
{
"name": "company_id",
"value": "",
"type": "query",
"description": "Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create or update properties about a profile without tracking an associated event.\n\nThis endpoint is specifically designed to be called from publicly-browseable, client-side environments only and requires a [public API key (site ID)](https://www.klaviyo.com/settings/account/api-keys). Never use a private API key with our client-side endpoints.\n\nDo not use this endpoint from server-side applications.\nTo create or update profiles from server-side applications, instead use [POST /api/profile-import]"
},
{
"info": {
"name": "Bulk Create Client Events",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://a.klaviyo.com/client/event-bulk-create",
"headers": [
{
"name": "revision",
"value": ""
}
],
"params": [
{
"name": "company_id",
"value": "",
"type": "query",
"description": "Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create new events to track a profile's activity.\n\nThis endpoint is specifically designed to be called from publicly-browseable, client-side environments only and requires a [public API key (site ID)](https://www.klaviyo.com/settings/account/api-keys). Never use a private API key with our client-side endpoints.\n\nDo not use this endpoint from server-side applications.\nTo create events from server-side applications, instead use [POST /api/event-bulk-create-jobs](https://developers.klaviyo.com/en/re"
},
{
"info": {
"name": "Create Client Back In Stock Subscription",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://a.klaviyo.com/client/back-in-stock-subscriptions",
"headers": [
{
"name": "revision",
"value": ""
}
],
"params": [
{
"name": "company_id",
"value": "",
"type": "query",
"description": "Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Subscribe a profile to receive back in stock notifications. Check out [our Back in Stock API guide](https://developers.klaviyo.com/en/docs/how_to_set_up_custom_back_in_stock) for more details.\n\nThis endpoint is specifically designed to be called from publicly-browseable, client-side environments only and requires a [public API key (site ID)](https://www.klaviyo.com/settings/account/api-keys). Never use a private API key with our client-side endpoints.\n\nDo not use this endpoint from server-side a"
}
]
}
],
"bundled": true
}