Skip to content

Latest commit

History

265 Commits

Folders and files

NameName
Last commit message
Last commit date

Repository files navigation

Klaviyo's OpenAPI Specification

Versioned OpenAPI specs for the Klaviyo API. Same source we use for API docs and our SDKs.

Layout

PathContentsUse it when
openapi/stable.jsonFull GA spec (~2.5 MB, all operations across all categories)SDK codegen, full validation, anything needing the complete surface
openapi/stable/categories/{category}.jsonPer-category slice — e.g. forms.json, profiles.json, templates.json, reporting.jsonGrounding an LLM against a single category; partner integrations scoped to one category
openapi/stable/apis/{operationId}.jsonPer-endpoint slice — e.g. create_form.json, get_profile.jsonTooling that operates on a single endpoint at a time
openapi/beta.json and openapi/beta/{categories,apis}/...Same layout for pre-release endpointsTesting forthcoming APIs before GA

operationId matches the developer portal URL slug 1:1 — /en/reference/create_formopenapi/stable/apis/create_form.json.

LLM agents — use the per-category slice

The full spec is too large for many WebFetch-style tools to consume reliably. Per-category slices (~50–200 KB) are self-contained OpenAPI 3 documents with all referenced components inlined and $ref semantics preserved.

Examples:

  • Forms → openapi/stable/categories/forms.json
  • Templates → openapi/stable/categories/templates.json
  • Profiles → openapi/stable/categories/profiles.json

Raw URLs (for curl, WebFetch, or grounding tools):

https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/categories/forms.json
https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_form.json

Revisions

Each API revision (e.g. 2026-04-15) lives on its own branch. The main branch tracks the latest GA revision.

Legacy

Legacy spec: https://klaviyo-openapi.s3.amazonaws.com/spec.json