How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Klaviyo

Klaviyo Profiles API

profiles

Documentation Provider Profile APIs.io OpenAPI GitHub

Klaviyo Profiles API is one of 23 APIs that Klaviyo publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Profiles. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, an API reference, authentication docs, and rate-limit docs.

This API exposes 36 operations across 29 paths, and defines 228 schemas. It is described by OpenAPI 3.2.0, at version 2026-04-15.

Requests are made against a single base URL, https://a.klaviyo.com.

36 operations 29 paths 228 schemas 1 DELETE25 GET1 PATCH9 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2026-04-15
Base URL
https://a.klaviyo.com
Authentication
API Key
Contact
Klaviyo Developer Experience Team
License
License
Terms of Service
View terms
Resource Areas
1

Authentication & Security 1

Klaviyo Profiles API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (Klaviyo-API-Key). By default, every request must be authenticated.

  • Klaviyo-API-Key — Private key authentication for /api/ endpoints is performed by setting the Authorization header to Klaviyo-API-Key your-private-api-key For more information pl…

Paths & Operations 36

Across 29 paths, the API surfaces 36 operations — 1 DELETE, 25 GET, 1 PATCH, 9 POST. Each is listed below with its method, path, parameters, and response codes.

Profiles 36

profiles

GET
/api/profiles
Get Profiles
get_profiles 9 params → 2004XX5XX
POST
/api/profiles
Create Profile
create_profile 2 params body → 2014XX5XX
GET
/api/profiles/{id}
Get Profile
get_profile 8 params → 2004XX5XX
PATCH
/api/profiles/{id}
Update Profile
update_profile 3 params body → 2004XX5XX
GET
/api/profile-bulk-import-jobs
Get Bulk Import Profiles Jobs
get_bulk_import_profiles_jobs 6 params → 2004XX5XX
POST
/api/profile-bulk-import-jobs
Bulk Import Profiles
bulk_import_profiles 1 param body → 2024XX5XX
GET
/api/profile-bulk-import-jobs/{job_id}
Get Bulk Import Profiles Job
get_bulk_import_profiles_job 5 params → 2004XX5XX
GET
/api/profile-suppression-bulk-create-jobs
Get Bulk Suppress Profiles Jobs
get_bulk_suppress_profiles_jobs 5 params → 2004XX5XX
POST
/api/profile-suppression-bulk-create-jobs
Bulk Suppress Profiles
bulk_suppress_profiles 1 param body → 2024XX5XX
GET
/api/profile-suppression-bulk-create-jobs/{job_id}
Get Bulk Suppress Profiles Job
get_bulk_suppress_profiles_job 3 params → 2004XX5XX
GET
/api/profile-suppression-bulk-delete-jobs
Get Bulk Unsuppress Profiles Jobs
get_bulk_unsuppress_profiles_jobs 5 params → 2004XX5XX
POST
/api/profile-suppression-bulk-delete-jobs
Bulk Unsuppress Profiles
bulk_unsuppress_profiles 1 param body → 2024XX5XX
GET
/api/profile-suppression-bulk-delete-jobs/{job_id}
Get Bulk Unsuppress Profiles Job
get_bulk_unsuppress_profiles_job 3 params → 2004XX5XX
GET
/api/push-tokens
Get Push Tokens
get_push_tokens 7 params → 2004XX5XX
POST
/api/push-tokens
Create or Update Push Token
create_push_token 1 param body → 2024XX5XX
GET
/api/push-tokens/{id}
Get Push Token
get_push_token 5 params → 2004XX5XX
DELETE
/api/push-tokens/{id}
Delete Push Token
delete_push_token 2 params → 2044XX5XX
POST
/api/profile-import
Create or Update Profile
create_or_update_profile 2 params body → 2002014XX5XX
POST
/api/profile-merge
Merge Profiles
merge_profiles 1 param body → 2014XX5XX
POST
/api/profile-subscription-bulk-create-jobs
Bulk Subscribe Profiles
bulk_subscribe_profiles 1 param body → 2024XX5XX
POST
/api/profile-subscription-bulk-delete-jobs
Bulk Unsubscribe Profiles
bulk_unsubscribe_profiles 1 param body → 2024XX5XX
GET
/api/profiles/{id}/push-tokens
Get Push Tokens for Profile
get_push_tokens_for_profile 3 params → 2004XX5XX
GET
/api/profiles/{id}/relationships/push-tokens
Get Push Token IDs for Profile
get_push_token_ids_for_profile 2 params → 2004XX5XX
GET
/api/profiles/{id}/lists
Get Lists for Profile
get_lists_for_profile 3 params → 2004XX5XX
GET
/api/profiles/{id}/relationships/lists
Get List IDs for Profile
get_list_ids_for_profile 2 params → 2004XX5XX
GET
/api/profiles/{id}/segments
Get Segments for Profile
get_segments_for_profile 3 params → 2004XX5XX
GET
/api/profiles/{id}/relationships/segments
Get Segment IDs for Profile
get_segment_ids_for_profile 2 params → 2004XX5XX
GET
/api/profiles/{id}/conversation
Get Conversation for Profile
get_conversation_for_profile 2 params → 2004XX5XX
GET
/api/profiles/{id}/relationships/conversation
Get Conversation ID for Profile
get_conversation_id_for_profile 2 params → 2004XX5XX
GET
/api/profile-bulk-import-jobs/{id}/lists
Get List for Bulk Import Profiles Job
get_list_for_bulk_import_profiles_job 3 params → 2004XX5XX
GET
/api/profile-bulk-import-jobs/{id}/relationships/lists
Get List IDs for Bulk Import Profiles Job
get_list_ids_for_bulk_import_profiles_job 2 params → 2004XX5XX
GET
/api/profile-bulk-import-jobs/{id}/profiles
Get Profiles for Bulk Import Profiles Job
get_profiles_for_bulk_import_profiles_job 6 params → 2004XX5XX
GET
/api/profile-bulk-import-jobs/{id}/relationships/profiles
Get Profile IDs for Bulk Import Profiles Job
get_profile_ids_for_bulk_import_profiles_job 4 params → 2004XX5XX
GET
/api/profile-bulk-import-jobs/{id}/import-errors
Get Errors for Bulk Import Profiles Job
get_errors_for_bulk_import_profiles_job 5 params → 2004XX5XX
GET
/api/push-tokens/{id}/profile
Get Profile for Push Token
get_profile_for_push_token 4 params → 2004XX5XX
GET
/api/push-tokens/{id}/relationships/profile
Get Profile ID for Push Token
get_profile_id_for_push_token 2 params → 2004XX5XX

Schemas 228

The contract defines 228 schemas that model the data the API accepts and returns. The most detailed are DeviceMetadata (12 properties), PushTokenDeviceMetadata (12 properties), PredictiveAnalytics (10 properties), EmailMarketing (10 properties). Each schema is shown below with its type and property counts.

ErrorSource
object
1 property
GetProfileResponseCompoundDocument
object
3 properties 1 required
NoSMSMarketingConsent
object
3 properties 3 required
CustomSourceFilter
object
2 properties 2 required
IsSetExistenceFilter
object
2 properties 2 required
ProfilePredictiveAnalyticsChannelAffinityRankFilter
object
3 properties 3 required
WhatsappChannel
object
3 properties
GetBulkProfileSuppressionsRemoveJobResponseCollection
object
2 properties 1 required
PushChannel
object
1 property
HasSMSMarketingConsent
object
3 properties 3 required
ExistenceOperatorExistenceFilter
object
2 properties 2 required
LessThanPositiveNumericFilter
object
3 properties 3 required
ProfileRegionCondition
object
3 properties 3 required
SubscriptionDeleteJobCreateQueryResourceObject
object
3 properties 2 required
ListSubstringFilter
object
3 properties 3 required
ProvidedLandlineMethodFilter
object
2 properties 2 required
UnsubscriptionParameters
object
1 property 1 required
ProfileMergeQuery
object
1 property 1 required
SubscriptionParameters
object
2 properties 1 required
SuppressionCreateJobCreateQueryResourceObject
object
3 properties 2 required
ProfileHasCustomObjectFilter
object
2 properties 2 required
SMSChannel
object
2 properties
CarrierDeactivationMethodFilter
object
2 properties 2 required
NoEmailMarketing
object
2 properties 1 required
GetBulkProfileSuppressionsRemoveJobResponse
object
2 properties 1 required
GetProfileBulkImportJobProfilesRelationshipsResponseCollection
object
2 properties 1 required
EffectiveDateFilter
object
2 properties 2 required
PostProfileMergeResponse
object
2 properties 1 required
ProfilePredictiveAnalyticsStringFilter
object
3 properties 3 required
ProfilePredictiveAnalyticsChannelAffinityPriorityCondition
object
5 properties 5 required
NoEmailMarketingSubscribed
object
2 properties 2 required
GetImportErrorResponseCollection
object
2 properties 1 required
HasPushMarketingConsent
object
3 properties 3 required
PostBulkProfileSuppressionsRemoveJobResponse
object
2 properties 1 required
ProfileMetricPropertyFilter
object
2 properties 1 required
ShopifyIntegrationFilter
object
3 properties 3 required
PushTokenDeviceMetadata
object
12 properties
ProfilePredictiveAnalyticsStringCondition
object
3 properties 3 required
HasPushMarketing
object
2 properties 1 required
MailboxProviderMethodFilter
object
2 properties 2 required
ProfileMergeQueryResourceObject
object
3 properties 3 required
StringArrayOperatorStringArrayFilter
object
3 properties 3 required
ProfileCreateQuery
object
1 property 1 required
ProfilePredictiveAnalyticsDateCondition
object
3 properties 3 required
SubscriptionChannels
object
4 properties
ManualImportMethodFilter
object
2 properties 2 required
ProfileResponseObjectResource
object
5 properties 3 required
ProfilePropertyCondition
object
3 properties 3 required
InvalidEmailDateFilter
object
2 properties 2 required
HasEmailMarketingSubscribed
object
2 properties 1 required
PushSubscriptionParameters
object
3 properties 1 required
EmailMarketingSuppression
object
2 properties 2 required
GetProfileSegmentsRelationshipsResponseCollection
object
2 properties 1 required
StringPhoneOperatorStringArrayFilter
object
3 properties 3 required
WhatsAppSubscriptionParameters
object
2 properties
NoEmailMarketingUnsubscribed
object
2 properties 1 required
ProvidedNoAgeMethodFilter
object
2 properties 2 required
ImportErrorResponseObjectResource
object
3 properties 3 required
GetProfileBulkImportJobListsRelationshipsResponseCollection
object
2 properties 1 required
SegmentsProfileMetricFunnelCondition
object
4 properties 3 required
NoPushMarketingConsent
object
3 properties 3 required
PreferencePageMethodFilter
object
2 properties 2 required
SubscriptionCreateJobCreateQuery
object
1 property 1 required
ProfileNoGroupMembershipCondition
object
3 properties 3 required
EmailUnsubscriptionParameters
object
1 property 1 required
ProfileImportJobCreateQueryResourceObject
object
3 properties 2 required
StringOperatorStringFilter
object
3 properties 3 required
NoSMSMarketingUnsubscribed
object
2 properties 1 required
OnlyRelatedLinks
object
1 property 1 required
ProfileMetricFunnelSteps
object
3 properties 2 required
ListContainsOperatorListContainsFilter
object
3 properties 3 required
PredictiveAnalytics
object
10 properties
GetListResponseCollection
object
2 properties 1 required
HasEmailMarketing
object
2 properties 1 required
ManualImportManualMethodFilter
object
3 properties 2 required
ProfilePostalCodeDistanceCondition
object
5 properties 5 required
ProfilePartialUpdateQuery
object
1 property 1 required
PostBulkProfileSuppressionsCreateJobResponse
object
2 properties 1 required
ImplicitlyReachable
object
1 property 1 required
GreaterThanPositiveNumericFilter
object
3 properties 3 required
GetProfileResponseCollectionCompoundDocument
object
3 properties 1 required
CalendarDateFilter
object
3 properties 3 required
ConversationResponseObjectResource
object
4 properties 3 required
ProfileBulkImportJobEnum
string
ExplicitlyUnreachable
object
2 properties 2 required
SMSMarketing
object
6 properties 2 required
GetPushTokenResponseCollectionCompoundDocument
object
3 properties 1 required
CollectionLinks
object
5 properties 1 required
PushTokenEnum
string
TagEnum
string
ProfileSubscriptionDeleteQueryResourceObject
object
2 properties 2 required
ImplicitlyUnreachable
object
1 property 1 required
PushTokenCreateQueryResourceObject
object
2 properties 2 required
ConversationEnum
string
EqualsStringFilter
object
3 properties 3 required
CheckoutMethodFilter
object
2 properties 2 required
SegmentEnum
string
GetSegmentResponseCollection
object
2 properties 1 required
SftpMethodFilter
object
2 properties 2 required
FormMethodFilter
object
3 properties 2 required
StatusDateFilter
object
2 properties 2 required
FlowEnum
string
ProfileImportJobResponseObjectResource
object
5 properties 4 required
SpamComplaintMethodFilter
object
2 properties 2 required
SMSTransactional
object
6 properties 2 required
AlltimeDateFilter
object
2 properties 2 required
ProfileSuppressionCreateQueryResourceObject
object
2 properties 2 required
SMSSubscriptionParameters
object
2 properties
ProfileMeta
object
2 properties
ProfileImportJobCreateQuery
object
1 property 1 required
ProfileSuppressionBulkCreateJobEnum
string
ProfileEnum
string
DataWarehouseImportMethodFilter
object
2 properties 2 required
HasEmailMarketingConsent
object
3 properties 3 required
SubscribedSMSIsRcsCapableFilter
object
2 properties 2 required
ManualRemoveMethodFilter
object
2 properties 2 required
GetPushTokenResponseCollection
object
2 properties 1 required
IntegerFilter
object
3 properties 3 required
DoubleOptinFilter
object
2 properties 2 required
PostProfileImportJobResponse
object
2 properties 1 required
ProfileMetaPatchProperties
object
3 properties
NoEmailMarketingConsent
object
3 properties 3 required
Subscriptions
object
4 properties
RelativeDateRangeFilter
object
5 properties 5 required
ConditionGroup
object
1 property 1 required
ProfileHasCustomObjectCondition
object
5 properties 5 required
ObjectLinks
object
1 property 1 required
WhatsappTransactionalChannel
object
8 properties 3 required
StaticDateFilter
object
3 properties 3 required
FormSubscribeFilter
object
3 properties 2 required
PushTokenResponseObjectResource
object
5 properties 4 required
PreferencePageFilter
object
3 properties 2 required
ProfileModificationMethodFilter
object
2 properties 2 required
PushProfileUpsertQueryResourceObject
object
3 properties 2 required
ProfileSuppressionBulkDeleteJobEnum
string
DeviceMetadata
object
12 properties
GetProfilePushTokensRelationshipsResponseCollection
object
2 properties 1 required
PostProfileResponse
object
2 properties 1 required
RecordedDateFilter
object
2 properties 2 required
ListResponseObjectResource
object
5 properties 4 required
ProfilePredictiveAnalyticsChannelAffinityPriorityFilter
object
3 properties 3 required
ProfilePartialUpdateQueryResourceObject
object
4 properties 3 required
NumericOperatorNumericFilter
object
3 properties 3 required
ProfileSuppressionDeleteQueryResourceObject
object
2 properties 2 required
EmailChannel
object
1 property
ExplicitlyReachable
object
2 properties 2 required
ImplicitlyOrExplicitlyUnreachable
object
1 property 1 required
NoSMSMarketing
object
1 property 1 required
ListEnum
string
RelationshipLinks
object
2 properties 2 required
InStringArrayFilter
object
3 properties 3 required
ConstantContactIntegrationFilter
object
3 properties 3 required
OneClickUnsubscribeMethodFilter
object
2 properties 2 required
ProfileSubscriptionCreateQueryResourceObject
object
3 properties 2 required
PatchProfileResponse
object
2 properties 1 required
PushTokenCreateQuery
object
1 property 1 required
ProfileMergeEnum
string
EmailMarketing
object
10 properties 2 required
ProfileSubscriptionBulkDeleteJobEnum
string
PushUnsubscriptionParameters
object
2 properties 2 required
FailedAgeGateMethodFilter
object
2 properties 2 required
APIMethodFilter
object
3 properties 2 required
HasSMSMarketingSubscribed
object
2 properties 1 required
GetPushTokenResponseCompoundDocument
object
3 properties 1 required
PushTokenEntry
object
6 properties 3 required
GetProfileConversationRelationshipResponse
object
2 properties 1 required
GetConversationResponse
object
2 properties 1 required
BooleanFilter
object
3 properties 3 required
ProfileMarketingConsentCondition
object
2 properties 2 required
ImplicitlyOrExplicitlyReachable
object
1 property 1 required
GetBulkProfileSuppressionsCreateJobResponse
object
2 properties 1 required
SuppressionCreateJobCreateQuery
object
1 property 1 required
RelativeDateOperatorBaseRelativeDateFilter
object
4 properties 4 required
AnniversaryDateFilter
object
2 properties 2 required
MessageBlockedMethodFilter
object
2 properties 2 required
BulkRemoveMethodFilter
object
2 properties 2 required
EmailSubscriptionParameters
object
1 property 1 required
SuppressionDeleteJobCreateQuery
object
1 property 1 required
ProfileSubscriptionBulkCreateJobEnum
string
ListLengthFilter
object
3 properties 3 required
NoPushMarketing
object
1 property 1 required
SegmentResponseObjectResource
object
5 properties 4 required
PushMarketing
object
3 properties 2 required
ProfileUpsertQueryResourceObject
object
4 properties 2 required
GetBulkProfileSuppressionsCreateJobResponseCollection
object
2 properties 1 required
ProfileHasGroupMembershipCondition
object
4 properties 3 required
SubscriptionDeleteJobCreateQuery
object
1 property 1 required
ShopifyIntegrationMethodFilter
object
3 properties 3 required
BulkProfileSuppressionsCreateJobResponseObjectResource
object
5 properties 4 required
ImportErrorEnum
string
ProfilePermissionsCondition
object
3 properties 3 required
ProfileCreateQueryResourceObject
object
2 properties 2 required
StaticDateRangeFilter
object
4 properties 4 required
EmailMarketingListSuppression
object
3 properties 3 required
SubscriptionCreateJobCreateQueryResourceObject
object
3 properties 2 required
ProfileLocation
object
10 properties
WhatsappConversationalChannel
object
8 properties 3 required
BackInStockMethodFilter
object
2 properties 2 required
BulkProfileSuppressionsRemoveJobResponseObjectResource
object
5 properties 4 required
PatchIdentifiers
object
2 properties
BounceDateFilter
object
2 properties 2 required
NumericRangeFilter
object
4 properties 4 required
ListSetFilter
object
3 properties 3 required
ConstantContactIntegrationMethodFilter
object
3 properties 3 required
SegmentsProfileMetricCondition
object
6 properties 5 required
GetPushTokenProfileRelationshipResponse
object
2 properties 1 required
ManualAddManualMethodFilter
object
3 properties 2 required
GetProfileResponseCollection
object
2 properties 1 required
RelativeAnniversaryDateFilter
object
4 properties 4 required
GetProfileListsRelationshipsResponseCollection
object
2 properties 1 required
InboundMessageMethodFilter
object
2 properties 2 required
GetProfileResponse
object
2 properties 1 required
NoEmailMarketingNeverSubscribed
object
2 properties 2 required
SuppressionDeleteJobCreateQueryResourceObject
object
3 properties 2 required
ProfilePredictiveAnalyticsNumericCondition
object
3 properties 3 required
ProfilePredictiveAnalyticsChannelAffinityRankCondition
object
5 properties 5 required
ProfileUpsertQuery
object
1 property 1 required
HasEmailMarketingNeverSubscribed
object
2 properties 1 required
ManualSuppressionDateFilter
object
2 properties 2 required
SMSUnsubscriptionParameters
object
2 properties
SegmentDefinition
object
1 property 1 required
WhatsappMarketingChannel
object
8 properties 3 required
UnsubscriptionChannels
object
4 properties
GetProfileImportJobResponseCompoundDocument
object
3 properties 1 required
NoSMSMarketingNeverSubscribed
object
1 property 1 required
WhatsAppUnsubscriptionParameters
object
3 properties
GetProfileImportJobResponseCollectionCompoundDocument
object
2 properties 1 required
MethodFilter
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

klaviyo-profiles-api-openapi.yml Raw ↑

Other APIs Klaviyo publishes across the network.

Klaviyo Accounts API
AE Profile APIs.io
Klaviyo Campaigns API
AE Profile APIs.io
Klaviyo Catalogs API
AE Profile APIs.io
Klaviyo Client API
AE Profile APIs.io
Klaviyo Conversations API
AE Profile APIs.io
Klaviyo Coupons API
AE Profile APIs.io
Klaviyo Custom Objects API
AE Profile APIs.io
Klaviyo Data Privacy API
AE Profile APIs.io
Klaviyo Events API
AE Profile APIs.io
Klaviyo Flows API
AE Profile APIs.io
Klaviyo Forms API
AE Profile APIs.io
Klaviyo Images API
AE Profile APIs.io
#Profiles
← Back to K APIs
API Details
ID
klaviyo:klaviyo-profiles-api
Base URL
https://a.klaviyo.com
Docs
https://developers.klaviyo.com/
Provider
Klaviyo
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=klaviyo-profiles-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/klaviyo-profiles-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Klaviyo Profiles API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.