{
"openapi": "3.0.2",
"info": {
"title": "Klaviyo API",
"version": "2026-07-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/profile-suppression-bulk-delete-jobs": {
"get": {
"operationId": "get_bulk_unsuppress_profiles_jobs",
"summary": "Get Bulk Unsuppress Profiles Jobs",
"description": "Get all bulk unsuppress profiles jobs.
*Rate limits*:
Burst: `75/s`
Steady: `750/m`\n\n**Scopes:**\n`subscriptions:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_unsuppress_profiles_jobs.json)",
"parameters": [
{
"name": "fields[profile-suppression-bulk-delete-job]",
"in": "query",
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"completed_at",
"completed_count",
"created_at",
"id",
"skipped_count",
"status",
"total_count"
]
}
},
"explode": false
},
{
"name": "filter",
"in": "query",
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
`status`: `equals`
`list_id`: `equals`
`segment_id`: `equals`",
"schema": {
"type": "string",
"example": "equals(status,'processing')"
}
},
{
"name": "page[cursor]",
"in": "query",
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "sort",
"in": "query",
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sorting",
"schema": {
"type": "string",
"enum": [
"created",
"-created"
]
}
},
{
"name": "revision",
"in": "header",
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"required": true,
"schema": {
"type": "string",
"default": "2026-07-15"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetBulkProfileSuppressionsRemoveJobResponseCollection"
}
}
}
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"tags": [
"Profiles"
],
"x-klaviyo-filters": {
"status": {
"operators": {
"single": [
"equals"
]
},
"value": {
"type": "string",
"enum": [
"queued",
"processing",
"complete",
"cancelled"
]
}
},
"list_id": {
"operators": {
"single": [
"equals"
]
},
"value": {
"type": "string"
}
},
"segment_id": {
"operators": {
"single": [
"equals"
]
},
"value": {
"type": "string"
}
}
},
"x-klaviyo-operation-aliases": [
"get_profile_suppression_bulk_delete_jobs"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "75/s",
"steady": "750/m"
},
"x-klaviyo-scopes": [
"subscriptions:read"
],
"x-klaviyo-subtag": "Consent"
}
}
},
"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"
}
}
}
},
"BulkProfileSuppressionsRemoveJobResponseObjectResource": {
"type": "object",
"properties": {
"type": {
"$ref": "#/components/schemas/ProfileSuppressionBulkDeleteJobEnum"
},
"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
},
"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
},
"skipped_count": {
"description": "The total number of profiles that have been skipped as part of the job.",
"type": "integer",
"example": 1,
"default": 0,
"nullable": true
}
},
"required": [
"status",
"created_at",
"total_count"
]
},
"relationships": {
"type": "object",
"properties": {
"lists": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"$ref": "#/components/schemas/ListEnum"
},
"id": {
"description": "Suppress/Unsuppress all profiles in this list",
"type": "string",
"example": "Y6nRLr"
}
}
}
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
}
},
"segments": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"$ref": "#/components/schemas/SegmentEnum"
},
"id": {
"description": "Suppress/Unsuppress all profiles in this segment",
"type": "string",
"example": "Y6nRLr"
}
}
}
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
}
}
}
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"type",
"id",
"attributes",
"links"
]
},
"CollectionLinks": {
"type": "object",
"properties": {
"self": {
"type": "string",
"format": "uri"
},
"prev": {
"type": "string",
"format": "uri"
},
"next": {
"type": "string",
"format": "uri"
}
},
"required": [
"self"
]
},
"GetBulkProfileSuppressionsRemoveJobResponseCollection": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BulkProfileSuppressionsRemoveJobResponseObjectResource"
}
},
"links": {
"$ref": "#/components/schemas/CollectionLinks"
},
"meta": {
"$ref": "#/components/schemas/ResponseMeta"
}
},
"required": [
"data"
]
},
"ListEnum": {
"type": "string",
"enum": [
"list"
]
},
"ObjectLinks": {
"type": "object",
"properties": {
"self": {
"type": "string",
"format": "uri"
}
},
"required": [
"self"
]
},
"ProfileSuppressionBulkDeleteJobEnum": {
"type": "string",
"enum": [
"profile-suppression-bulk-delete-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/reference/api-overview#authentication",
"x-default": "Klaviyo-API-Key your-private-api-key"
}
}
},
"tags": [
{
"name": "Profiles",
"description": "profiles"
}
]
}