{ "openapi": "3.0.2", "info": { "title": "Klaviyo API (Beta)", "version": "2026-07-15.pre", "description": "The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.", "contact": { "name": "Klaviyo Developer Experience Team", "email": "developers@klaviyo.com", "url": "https://developers.klaviyo.com" }, "termsOfService": "https://www.klaviyo.com/legal/api-terms", "license": { "name": "License", "url": "https://www.klaviyo.com/legal" } }, "servers": [ { "url": "https://a.klaviyo.com", "description": "Production" } ], "security": [ { "Klaviyo-API-Key": [] } ], "paths": { "/api/profile-bulk-export-jobs": { "post": { "operationId": "create_profile_bulk_export_job_beta", "summary": "Create Profile Bulk Export Job", "description": "\n > \ud83d\udea7 This endpoint is in beta and subject to change.\n >\n > A beta revision header (2026-07-15.pre) is required to use our beta APIs. Klaviyo APIs in beta are not intended for use in production. See our [versioning and deprecation policy](https://developers.klaviyo.com/en/docs/api_versioning_and_deprecation_policy) for more information.\n\nCreate a new bulk export job to export profiles from a given group (list or segment).\n\nThis API is invite-only during beta: access is limited to allow-listed API keys and OAuth applications.\n\nThe export runs asynchronously. Use the returned job ID to check the status\nand retrieve the download URL when complete.

*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n**Scopes:**\n`lists:read`\n`profiles:read`\n`segments:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/beta/apis/create_profile_bulk_export_job_beta.json)", "parameters": [ { "name": "fields[profile-bulk-export-job]", "in": "query", "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15.pre/reference/api-overview#sparse-fieldsets", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "created_at", "id", "status" ] } }, "explode": false }, { "name": "revision", "in": "header", "description": "API endpoint revision (format: YYYY-MM-DD[.suffix])", "required": true, "schema": { "type": "string", "default": "2026-07-15.pre" } } ], "requestBody": { "description": "Request DTO for creating a profile bulk export job", "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ProfileBulkExportJobCreateQuery" } } } }, "responses": { "201": { "description": "Success", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/PostProfileBulkExportJobCreateResponse" } } } }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } }, "tags": [ "Beta APIs" ], "x-klaviyo-pre-release": "BETA", "x-klaviyo-ratelimit": { "burst": "10/s", "steady": "150/m" }, "x-klaviyo-scopes": [ "lists:read", "profiles:read", "segments:read" ], "x-klaviyo-subtag": "Profiles" } } }, "components": { "responses": { "ClientError": { "description": "Client Error", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "required": [ "id", "code", "title", "detail" ], "properties": { "id": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "detail": { "type": "string" }, "source": { "type": "object", "properties": { "pointer": { "type": "string" }, "parameter": { "type": "string" } } } } } } }, "required": [ "errors" ] } } } }, "ServerError": { "description": "Server Error", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "required": [ "id", "code", "title", "detail" ], "properties": { "id": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "detail": { "type": "string" }, "source": { "type": "object", "properties": { "pointer": { "type": "string" }, "parameter": { "type": "string" } } } } } } }, "required": [ "errors" ] } } } } }, "schemas": { "AgentHints": { "description": "Optional hints emitted by the API for agent callers", "type": "object", "properties": { "next_steps": { "description": "Suggested follow-up actions for agents to take after this response", "type": "array", "items": { "type": "string" } } } }, "ListEnum": { "type": "string", "enum": [ "list" ] }, "ObjectLinks": { "type": "object", "properties": { "self": { "type": "string", "format": "uri" } }, "required": [ "self" ] }, "PostProfileBulkExportJobCreateResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/ProfileBulkExportJobEnum" }, "id": { "description": "Unique identifier for the export job.", "type": "string", "example": "01GSQPBF74KQ5YTDEPP41T1BZH" }, "attributes": { "type": "object", "properties": { "status": { "description": "Current status of the export job. Always 'processing' when first created.", "type": "string", "example": "processing", "enum": [ "complete", "expired", "failed", "processing" ] }, "created_at": { "description": "Date and time the job was created in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).", "type": "string", "format": "date-time", "example": "2022-11-08T00:00:00+00:00" } }, "required": [ "status", "created_at" ] }, "relationships": { "type": "object", "properties": { "list": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/ListEnum" }, "id": { "description": "The list that profiles were exported from.", "type": "string", "example": "VRgFBd" } }, "required": [ "type", "id" ] }, "links": { "$ref": "#/components/schemas/RelationshipLinks" } } }, "segment": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/SegmentEnum" }, "id": { "description": "The segment that profiles were exported from.", "type": "string", "example": "ABC123" } }, "required": [ "type", "id" ] }, "links": { "$ref": "#/components/schemas/RelationshipLinks" } } } } }, "links": { "$ref": "#/components/schemas/ObjectLinks" } }, "required": [ "type", "id", "attributes", "links" ] }, "links": { "$ref": "#/components/schemas/ObjectLinks" }, "meta": { "$ref": "#/components/schemas/ResponseMeta" } }, "required": [ "data" ] }, "ProfileBulkExportJobCreateQuery": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ProfileBulkExportJobCreateQueryResourceObject" } }, "required": [ "data" ] }, "ProfileBulkExportJobCreateQueryResourceObject": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/ProfileBulkExportJobEnum" }, "attributes": { "type": "object", "properties": { "properties": { "description": "List of profile property keys to export.", "type": "array", "items": { "type": "string" }, "example": [ "email", "first_name", "properties['custom_property']" ], "nullable": true } } }, "relationships": { "type": "object", "properties": { "list": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/ListEnum" }, "id": { "description": "The list to export profiles from. Either lists or segments must be provided, but not both.", "type": "string", "example": "VRgFBd" } }, "required": [ "type", "id" ] } } }, "segment": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/SegmentEnum" }, "id": { "description": "The segment to export profiles from. Either lists or segments must be provided, but not both.", "type": "string", "example": "ABC123" } }, "required": [ "type", "id" ] } } } } } }, "required": [ "type", "attributes" ] }, "ProfileBulkExportJobEnum": { "type": "string", "enum": [ "profile-bulk-export-job" ] }, "RelationshipLinks": { "type": "object", "properties": { "self": { "type": "string", "format": "uri" }, "related": { "type": "string", "format": "uri" } }, "required": [ "self", "related" ] }, "ResponseMeta": { "description": "Response-level metadata", "type": "object", "properties": { "agent_hints": { "$ref": "#/components/schemas/AgentHints" } } }, "SegmentEnum": { "type": "string", "enum": [ "segment" ] } }, "securitySchemes": { "Klaviyo-API-Key": { "type": "apiKey", "in": "header", "name": "Authorization", "description": "Private key authentication for /api/ endpoints is performed by setting the `Authorization` header to `Klaviyo-API-Key your-private-api-key`
For more information please visit https://developers.klaviyo.com/en/v2026-07-15.pre/reference/api-overview#authentication", "x-default": "Klaviyo-API-Key your-private-api-key" } } }, "tags": [ { "name": "Beta APIs", "description": "beta apis" } ] }