{"openapi":"3.1.0","info":{"title":"Klaviyo (BYOK) API","version":"0.1.0","description":"Klaviyo (BYOK) lets an AI assistant read your own Klaviyo data through the Klaviyo API with a key you supply (private API key (starts with pk_)). Read-only: 7 tools (get_account, list_profiles, list_lists, list_segments, list_campaigns, list_flows, list_metrics). The BYOK key travels with each request, is used for that one call only and is never stored, logged or cached; it is only ever sent to...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-klaviyo.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-klaviyo/docs"},"termsOfService":"https://connectorbay.com/byok-klaviyo/terms"},"servers":[{"url":"https://byok-klaviyo.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-klaviyo/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/get_account":{"post":{"operationId":"get_account","summary":"Show the Klaviyo account the key belongs to: organization name, default sender, website, industry, time zone, currency a","description":"Show the Klaviyo account the key belongs to: organization name, default sender, website, industry, time zone, currency and locale. Needs the accounts:read scope. Use for \"Which Klaviyo account is my key connected to\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"get_accountArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_profiles":{"post":{"operationId":"list_profiles","summary":"List customer profiles with email, phone, name, organization, location and created, updated and last event dates. Newest","description":"List customer profiles with email, phone, name, organization, location and created, updated and last event dates. Newest first by default; can be filtered. Needs the profiles:read scope. Use for \"Find the Klaviyo profile for jane@example.com\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"filter":{"anyOf":[{"maxLength":300,"type":"string"},{"type":"null"}],"default":null,"description":"Optional Klaviyo filter expression, for example equals(email,\"jane@example.com\") or greater-than(updated,2026-01-01T00:00:00Z). Filterable: id, email, phone_number, external_id (equals); created, updated (greater-than, less-than).","title":"Filter"},"sort":{"anyOf":[{"enum":["created","-created","email","-email","id","-id","updated","-updated"],"type":"string"},{"type":"null"}],"default":null,"description":"Sort field; prefix with - for descending. One of: created, email, id, updated.","title":"Sort"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many results to return (1 to 100).","title":"Page Size"},"cursor":{"anyOf":[{"maxLength":500,"type":"string"},{"type":"null"}],"default":null,"description":"Paging cursor: take the page[cursor] value from the query string of links.next in the previous answer; leave empty for the first page.","title":"Cursor"}},"title":"list_profilesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_lists":{"post":{"operationId":"list_lists","summary":"List the lists in the account with their IDs, names, opt-in process (single or double) and dates. At most 10 per page. N","description":"List the lists in the account with their IDs, names, opt-in process (single or double) and dates. At most 10 per page. Needs the lists:read scope. Use for \"What lists do I have in Klaviyo\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"filter":{"anyOf":[{"maxLength":300,"type":"string"},{"type":"null"}],"default":null,"description":"Optional filter, for example equals(name,[\"Newsletter\"]) or greater-than(updated,2026-01-01T00:00:00Z).","title":"Filter"},"sort":{"anyOf":[{"enum":["created","-created","id","-id","name","-name","updated","-updated"],"type":"string"},{"type":"null"}],"default":null,"description":"Sort field; prefix with - for descending. One of: created, id, name, updated.","title":"Sort"},"cursor":{"anyOf":[{"maxLength":500,"type":"string"},{"type":"null"}],"default":null,"description":"Paging cursor: take the page[cursor] value from the query string of links.next in the previous answer; leave empty for the first page.","title":"Cursor"}},"title":"list_listsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_segments":{"post":{"operationId":"list_segments","summary":"List segments with their IDs, names, active, processing and starred flags and dates. At most 10 per page. Needs the segm","description":"List segments with their IDs, names, active, processing and starred flags and dates. At most 10 per page. Needs the segments:read scope. Use for \"Which Klaviyo segments are active\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"filter":{"anyOf":[{"maxLength":300,"type":"string"},{"type":"null"}],"default":null,"description":"Optional filter, for example equals(is_active,true) or equals(name,[\"Engaged\"]).","title":"Filter"},"sort":{"anyOf":[{"enum":["created","-created","id","-id","name","-name","updated","-updated"],"type":"string"},{"type":"null"}],"default":null,"description":"Sort field; prefix with - for descending. One of: created, id, name, updated.","title":"Sort"},"cursor":{"anyOf":[{"maxLength":500,"type":"string"},{"type":"null"}],"default":null,"description":"Paging cursor: take the page[cursor] value from the query string of links.next in the previous answer; leave empty for the first page.","title":"Cursor"}},"title":"list_segmentsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_campaigns":{"post":{"operationId":"list_campaigns","summary":"List campaigns of one channel with name, status, archived flag, scheduled and send times and dates. A channel filter is ","description":"List campaigns of one channel with name, status, archived flag, scheduled and send times and dates. A channel filter is required by Klaviyo. This only reads; it never sends. Needs the campaigns:read scope. Use for \"Show my latest Klaviyo email campaigns\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"filter":{"description":"Required Klaviyo filter naming the channel: equals(messages.channel,'email'), 'sms' or 'mobile_push'. May be combined with and(...) other filters such as equals(archived,false) or contains(name,'sale').","maxLength":300,"title":"Filter","type":"string"},"sort":{"anyOf":[{"enum":["created_at","-created_at","id","-id","name","-name","scheduled_at","-scheduled_at","updated_at","-updated_at"],"type":"string"},{"type":"null"}],"default":null,"description":"Sort field; prefix with - for descending. One of: created_at, id, name, scheduled_at, updated_at.","title":"Sort"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many results to return (1 to 100).","title":"Page Size"},"cursor":{"anyOf":[{"maxLength":500,"type":"string"},{"type":"null"}],"default":null,"description":"Paging cursor: take the page[cursor] value from the query string of links.next in the previous answer; leave empty for the first page.","title":"Cursor"}},"required":["filter"],"title":"list_campaignsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_flows":{"post":{"operationId":"list_flows","summary":"List automation flows with name, status, trigger type, archived flag and dates. Needs the flows:read scope. Use for \"Whi","description":"List automation flows with name, status, trigger type, archived flag and dates. Needs the flows:read scope. Use for \"Which Klaviyo flows are live\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"filter":{"anyOf":[{"maxLength":300,"type":"string"},{"type":"null"}],"default":null,"description":"Optional filter, for example equals(status,\"live\"), equals(archived,false) or contains(name,\"welcome\").","title":"Filter"},"sort":{"anyOf":[{"enum":["created","-created","id","-id","name","-name","status","-status","trigger_type","-trigger_type","updated","-updated"],"type":"string"},{"type":"null"}],"default":null,"description":"Sort field; prefix with - for descending. One of: created, id, name, status, trigger_type, updated.","title":"Sort"},"page_size":{"anyOf":[{"maximum":50,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"How many results to return (1 to 50).","title":"Page Size"},"cursor":{"anyOf":[{"maxLength":500,"type":"string"},{"type":"null"}],"default":null,"description":"Paging cursor: take the page[cursor] value from the query string of links.next in the previous answer; leave empty for the first page.","title":"Cursor"}},"title":"list_flowsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_metrics":{"post":{"operationId":"list_metrics","summary":"List the event metrics of the account (for example Placed Order or Opened Email) with IDs, names, integration and dates.","description":"List the event metrics of the account (for example Placed Order or Opened Email) with IDs, names, integration and dates. Needs the metrics:read scope. Use for \"What event metrics are tracked in my Klaviyo account\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"filter":{"anyOf":[{"maxLength":300,"type":"string"},{"type":"null"}],"default":null,"description":"Optional filter on the integration: equals(integration.name,\"Shopify\") or equals(integration.category,\"eCommerce\").","title":"Filter"},"cursor":{"anyOf":[{"maxLength":500,"type":"string"},{"type":"null"}],"default":null,"description":"Paging cursor: take the page[cursor] value from the query string of links.next in the previous answer; leave empty for the first page.","title":"Cursor"}},"title":"list_metricsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}