{
"openapi": "3.0.2",
"info": {
"title": "Klaviyo API",
"version": "2026-04-15",
"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/coupon-code-bulk-create-jobs/{job_id}": {
"get": {
"operationId": "get_bulk_create_coupon_codes_job",
"summary": "Get Bulk Create Coupon Codes Job",
"description": "Get a coupon code bulk create job with the given job ID.
*Rate limits*:
Burst: `75/s`
Steady: `750/m`\n\n**Scopes:**\n`coupon-codes:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_create_coupon_codes_job.json)",
"parameters": [
{
"name": "job_id",
"in": "path",
"description": "ID of the job to retrieve.",
"required": true,
"schema": {
"description": "ID of the job to retrieve.",
"type": "string",
"example": "01GSQPBF74KQ5YTDEPP41T1BZH"
}
},
{
"name": "fields[coupon-code-bulk-create-job]",
"in": "query",
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"completed_at",
"completed_count",
"created_at",
"errors",
"expires_at",
"failed_count",
"id",
"status",
"total_count"
]
}
},
"explode": false
},
{
"name": "fields[coupon-code]",
"in": "query",
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"expires_at",
"id",
"status",
"unique_code"
]
}
},
"explode": false
},
{
"name": "include",
"in": "query",
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships",
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"coupon-codes"
]
}
},
"explode": false
},
{
"name": "revision",
"in": "header",
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"required": true,
"schema": {
"type": "string",
"default": "2026-04-15"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetCouponCodeCreateJobResponseCompoundDocument"
}
}
}
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"tags": [
"Coupons"
],
"x-klaviyo-operation-aliases": [
"get_coupon_code_bulk_create_job"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "75/s",
"steady": "750/m"
},
"x-klaviyo-scopes": [
"coupon-codes:read"
]
}
}
},
"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": {
"APIJobErrorPayload": {
"type": "object",
"properties": {
"id": {
"description": "Unique identifier for the error.",
"type": "string",
"example": "e4eebb08-b055-4a6f-bb13-c8cb69c9eb94"
},
"code": {
"description": "A code for classifying the error type.",
"type": "string",
"example": "invalid"
},
"title": {
"description": "A high-level message about the error.",
"type": "string",
"example": "Invalid input"
},
"detail": {
"description": "Specific details about the error.",
"type": "string",
"example": "The payload provided in the request is invalid."
},
"source": {
"description": "Additional information on the source of the error.",
"$ref": "#/components/schemas/ErrorSource"
}
},
"required": [
"id",
"code",
"title",
"detail",
"source"
]
},
"CouponCodeBulkCreateJobEnum": {
"type": "string",
"enum": [
"coupon-code-bulk-create-job"
]
},
"CouponCodeCreateJobResponseObjectResource": {
"type": "object",
"properties": {
"type": {
"$ref": "#/components/schemas/CouponCodeBulkCreateJobEnum"
},
"id": {
"description": "Unique identifier for retrieving the job. Generated by Klaviyo.",
"type": "string"
},
"attributes": {
"type": "object",
"properties": {
"status": {
"description": "Status of the asynchronous job.",
"type": "string",
"example": "processing",
"enum": [
"cancelled",
"complete",
"processing",
"queued"
]
},
"created_at": {
"description": "The 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"
},
"total_count": {
"description": "The total number of operations to be processed by the job. See `completed_count` for the job's current progress.",
"type": "integer",
"example": 10
},
"completed_count": {
"description": "The total number of operations that have been completed by the job.",
"type": "integer",
"example": 9,
"default": 0,
"nullable": true
},
"failed_count": {
"description": "The total number of operations that have failed as part of the job.",
"type": "integer",
"example": 1,
"default": 0,
"nullable": true
},
"completed_at": {
"description": "Date and time the job was completed in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"type": "string",
"format": "date-time",
"example": "2022-11-08T00:00:00+00:00",
"nullable": true
},
"errors": {
"description": "Array of errors encountered during the processing of the job.",
"type": "array",
"items": {
"$ref": "#/components/schemas/APIJobErrorPayload"
},
"nullable": true
},
"expires_at": {
"description": "Date and time the job expires in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"type": "string",
"format": "date-time",
"example": "2022-11-08T00:00:00+00:00",
"nullable": true
}
},
"required": [
"status",
"created_at",
"total_count"
]
},
"relationships": {
"type": "object",
"properties": {
"coupon-codes": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"$ref": "#/components/schemas/CouponCodeEnum"
},
"id": {
"description": "IDs of the created coupon codes.",
"type": "string",
"example": "10OFF-ASD325FHK324UJDOI2M3JNES99"
}
}
}
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
}
}
}
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"type",
"id",
"attributes",
"links"
]
},
"CouponCodeEnum": {
"type": "string",
"enum": [
"coupon-code"
]
},
"CouponCodeResponseObjectResource": {
"type": "object",
"properties": {
"type": {
"$ref": "#/components/schemas/CouponCodeEnum"
},
"id": {
"description": "The id of a coupon code is a combination of its unique code and the id of the coupon it is associated with.",
"type": "string",
"example": "10OFF-ASD325FHK324UJDOI2M3JNES99"
},
"attributes": {
"type": "object",
"properties": {
"unique_code": {
"description": "This is a unique string that will be or is assigned to each customer/profile and is associated with a coupon.",
"type": "string",
"example": "ASD325FHK324UJDOI2M3JNES99",
"nullable": true
},
"expires_at": {
"description": "The datetime when this coupon code will expire. If not specified or set to null, it will be automatically set to 1 year.",
"type": "string",
"format": "date-time",
"example": "2022-11-08T00:00:00+00:00",
"nullable": true
},
"status": {
"description": "The current status of the coupon code.",
"type": "string",
"example": "UNASSIGNED",
"enum": [
"ASSIGNED_TO_PROFILE",
"DELETING",
"PROCESSING",
"UNASSIGNED",
"USED",
"VERSION_NOT_ACTIVE"
],
"nullable": true
}
}
},
"relationships": {
"type": "object",
"properties": {
"coupon": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"$ref": "#/components/schemas/CouponEnum"
},
"id": {
"type": "string",
"example": "10OFF"
}
},
"required": [
"type",
"id"
]
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
}
},
"profile": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"$ref": "#/components/schemas/ProfileEnum"
},
"id": {
"type": "string",
"example": "01GDDKASAP8TKDDA2GRZDSVP4H"
}
},
"required": [
"type",
"id"
]
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
}
}
}
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"type",
"id",
"attributes",
"links"
]
},
"CouponEnum": {
"type": "string",
"enum": [
"coupon"
]
},
"ErrorSource": {
"type": "object",
"properties": {
"pointer": {
"description": "A pointer to the source of the error in the request payload.",
"type": "string",
"example": "/data",
"default": "/data",
"nullable": true
}
}
},
"GetCouponCodeCreateJobResponseCompoundDocument": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/CouponCodeCreateJobResponseObjectResource"
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CouponCodeResponseObjectResource"
}
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
]
},
"ObjectLinks": {
"type": "object",
"properties": {
"self": {
"type": "string",
"format": "uri"
}
},
"required": [
"self"
]
},
"ProfileEnum": {
"type": "string",
"enum": [
"profile"
]
},
"RelationshipLinks": {
"type": "object",
"properties": {
"self": {
"type": "string",
"format": "uri"
},
"related": {
"type": "string",
"format": "uri"
}
},
"required": [
"self",
"related"
]
}
},
"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-04-15/reference/api-overview#authentication",
"x-default": "Klaviyo-API-Key your-private-api-key"
}
}
},
"tags": [
{
"name": "Coupons",
"description": "coupons"
}
]
}