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.0.2, 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.
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
POST
/api/profiles
Create Profile
GET
/api/profiles/{id}
Get Profile
PATCH
/api/profiles/{id}
Update Profile
GET
/api/profile-bulk-import-jobs
Get Bulk Import Profiles Jobs
POST
/api/profile-bulk-import-jobs
Bulk Import Profiles
GET
/api/profile-bulk-import-jobs/{job_id}
Get Bulk Import Profiles Job
GET
/api/profile-suppression-bulk-create-jobs
Get Bulk Suppress Profiles Jobs
POST
/api/profile-suppression-bulk-create-jobs
Bulk Suppress Profiles
GET
/api/profile-suppression-bulk-create-jobs/{job_id}
Get Bulk Suppress Profiles Job
GET
/api/profile-suppression-bulk-delete-jobs
Get Bulk Unsuppress Profiles Jobs
POST
/api/profile-suppression-bulk-delete-jobs
Bulk Unsuppress Profiles
GET
/api/profile-suppression-bulk-delete-jobs/{job_id}
Get Bulk Unsuppress Profiles Job
GET
/api/push-tokens
Get Push Tokens
POST
/api/push-tokens
Create or Update Push Token
GET
/api/push-tokens/{id}
Get Push Token
DELETE
/api/push-tokens/{id}
Delete Push Token
POST
/api/profile-import
Create or Update Profile
POST
/api/profile-merge
Merge Profiles
POST
/api/profile-subscription-bulk-create-jobs
Bulk Subscribe Profiles
POST
/api/profile-subscription-bulk-delete-jobs
Bulk Unsubscribe Profiles
GET
/api/profiles/{id}/push-tokens
Get Push Tokens for Profile
GET
/api/profiles/{id}/relationships/push-tokens
Get Push Token IDs for Profile
GET
/api/profiles/{id}/lists
Get Lists for Profile
GET
/api/profiles/{id}/relationships/lists
Get List IDs for Profile
GET
/api/profiles/{id}/segments
Get Segments for Profile
GET
/api/profiles/{id}/relationships/segments
Get Segment IDs for Profile
GET
/api/profiles/{id}/conversation
Get Conversation for Profile
GET
/api/profiles/{id}/relationships/conversation
Get Conversation ID for Profile
GET
/api/profile-bulk-import-jobs/{id}/lists
Get List for Bulk Import Profiles Job
GET
/api/profile-bulk-import-jobs/{id}/relationships/lists
Get List IDs for Bulk Import Profiles Job
GET
/api/profile-bulk-import-jobs/{id}/profiles
Get Profiles for Bulk Import Profiles Job
GET
/api/profile-bulk-import-jobs/{id}/relationships/profiles
Get Profile IDs for Bulk Import Profiles Job
GET
/api/profile-bulk-import-jobs/{id}/import-errors
Get Errors for Bulk Import Profiles Job
GET
/api/push-tokens/{id}/profile
Get Profile for Push Token
GET
/api/push-tokens/{id}/relationships/profile
Get Profile ID for Push Token
Schemas 228
The contract defines 228 schemas that model the data the API accepts and returns. The most detailed are PushTokenDeviceMetadata (12 properties), DeviceMetadata (12 properties), PredictiveAnalytics (10 properties), ProfileLocation (10 properties). Each schema is shown below with its type and property counts.
MessageBlockedMethodFilter
object
2 properties
2 required
ConstantContactIntegrationFilter
object
3 properties
3 required
NoEmailMarketingNeverSubscribed
object
2 properties
2 required
PostBulkProfileSuppressionsCreateJobResponse
object
2 properties
1 required
GetPushTokenResponseCollectionCompoundDocument
object
3 properties
1 required
GetListResponseCollection
object
2 properties
1 required
GetPushTokenProfileRelationshipResponse
object
2 properties
1 required
ProfilePredictiveAnalyticsChannelAffinityPriorityCondition
object
5 properties
5 required
ProfileSuppressionBulkCreateJobEnum
string
ListEnum
string
PushTokenResponseObjectResource
object
5 properties
4 required
GetBulkProfileSuppressionsCreateJobResponseCollection
object
2 properties
1 required
StatusDateFilter
object
2 properties
2 required
PredictiveAnalytics
object
10 properties
ProfileUpsertQueryResourceObject
object
4 properties
2 required
ProfileSuppressionBulkDeleteJobEnum
string
PushChannel
object
1 property
HasPushMarketingConsent
object
3 properties
3 required
ProfileEnum
string
GetBulkProfileSuppressionsRemoveJobResponse
object
2 properties
1 required
BulkProfileSuppressionsCreateJobResponseObjectResource
object
5 properties
4 required
ProfileModificationMethodFilter
object
2 properties
2 required
CheckoutMethodFilter
object
2 properties
2 required
PushMarketing
object
3 properties
2 required
SuppressionCreateJobCreateQuery
object
1 property
1 required
WhatsappMarketingChannel
object
8 properties
3 required
RelativeAnniversaryDateFilter
object
4 properties
4 required
ImportErrorEnum
string
ProfilePredictiveAnalyticsStringFilter
object
3 properties
3 required
ProfileCreateQuery
object
1 property
1 required
ShopifyIntegrationFilter
object
3 properties
3 required
ObjectLinks
object
1 property
1 required
ExplicitlyUnreachable
object
2 properties
2 required
ProfileMarketingConsentCondition
object
2 properties
2 required
PreferencePageFilter
object
3 properties
2 required
DoubleOptinFilter
object
2 properties
2 required
NoSMSMarketingUnsubscribed
object
2 properties
1 required
GetBulkProfileSuppressionsCreateJobResponse
object
2 properties
1 required
MethodFilter
object
2 properties
2 required
TagEnum
string
FailedAgeGateMethodFilter
object
2 properties
2 required
ProfileMetaPatchProperties
object
3 properties
SuppressionCreateJobCreateQueryResourceObject
object
3 properties
2 required
UnsubscriptionChannels
object
4 properties
ImportErrorResponseObjectResource
object
3 properties
3 required
ProfileHasCustomObjectFilter
object
2 properties
2 required
ConstantContactIntegrationMethodFilter
object
3 properties
3 required
PushTokenEnum
string
HasEmailMarketingNeverSubscribed
object
2 properties
1 required
GetProfileListsRelationshipsResponseCollection
object
2 properties
1 required
NumericRangeFilter
object
4 properties
4 required
FormSubscribeFilter
object
3 properties
2 required
NoSMSMarketingConsent
object
3 properties
3 required
ProvidedNoAgeMethodFilter
object
2 properties
2 required
ProfileSubscriptionBulkCreateJobEnum
string
PostBulkProfileSuppressionsRemoveJobResponse
object
2 properties
1 required
ProfileMeta
object
2 properties
SubscribedSMSIsRcsCapableFilter
object
2 properties
2 required
SMSUnsubscriptionParameters
object
2 properties
GetProfileResponse
object
2 properties
1 required
GetProfileConversationRelationshipResponse
object
2 properties
1 required
APIMethodFilter
object
3 properties
2 required
ConversationResponseObjectResource
object
4 properties
3 required
StaticDateFilter
object
3 properties
3 required
ProfileSuppressionDeleteQueryResourceObject
object
2 properties
2 required
ExplicitlyReachable
object
2 properties
2 required
ListLengthFilter
object
3 properties
3 required
GetProfileImportJobResponseCompoundDocument
object
3 properties
1 required
RecordedDateFilter
object
2 properties
2 required
SftpMethodFilter
object
2 properties
2 required
PushTokenEntry
object
6 properties
3 required
InvalidEmailDateFilter
object
2 properties
2 required
WhatsappChannel
object
3 properties
CarrierDeactivationMethodFilter
object
2 properties
2 required
PushUnsubscriptionParameters
object
2 properties
2 required
HasPushMarketing
object
2 properties
1 required
ProfileMergeQueryResourceObject
object
3 properties
3 required
ImplicitlyReachable
object
1 property
1 required
EffectiveDateFilter
object
2 properties
2 required
SpamComplaintMethodFilter
object
2 properties
2 required
ListResponseObjectResource
object
5 properties
4 required
WhatsAppUnsubscriptionParameters
object
3 properties
FlowEnum
string
EmailChannel
object
1 property
DataWarehouseImportMethodFilter
object
2 properties
2 required
EqualsStringFilter
object
3 properties
3 required
GetProfileBulkImportJobListsRelationshipsResponseCollection
object
2 properties
1 required
SuppressionDeleteJobCreateQueryResourceObject
object
3 properties
2 required
SuppressionDeleteJobCreateQuery
object
1 property
1 required
BooleanFilter
object
3 properties
3 required
ProfileSubscriptionBulkDeleteJobEnum
string
ProfilePredictiveAnalyticsChannelAffinityRankFilter
object
3 properties
3 required
ManualImportMethodFilter
object
2 properties
2 required
WhatsappConversationalChannel
object
8 properties
3 required
ProfilePredictiveAnalyticsChannelAffinityPriorityFilter
object
3 properties
3 required
ProfileHasCustomObjectCondition
object
5 properties
5 required
ImplicitlyUnreachable
object
1 property
1 required
EmailUnsubscriptionParameters
object
1 property
1 required
SMSSubscriptionParameters
object
2 properties
ProfilePropertyCondition
object
3 properties
3 required
NoEmailMarketingUnsubscribed
object
2 properties
1 required
BulkProfileSuppressionsRemoveJobResponseObjectResource
object
5 properties
4 required
RelationshipLinks
object
2 properties
2 required
BounceDateFilter
object
2 properties
2 required
NoEmailMarketing
object
2 properties
1 required
PostProfileMergeResponse
object
2 properties
1 required
ImplicitlyOrExplicitlyUnreachable
object
1 property
1 required
ProfileMergeQuery
object
1 property
1 required
NoPushMarketingConsent
object
3 properties
3 required
ProfileCreateQueryResourceObject
object
2 properties
2 required
EmailMarketing
object
10 properties
2 required
StaticDateRangeFilter
object
4 properties
4 required
SMSTransactional
object
6 properties
2 required
ProfileHasGroupMembershipCondition
object
4 properties
3 required
WhatsappTransactionalChannel
object
8 properties
3 required
ProfilePartialUpdateQueryResourceObject
object
4 properties
3 required
SubscriptionCreateJobCreateQueryResourceObject
object
3 properties
2 required
Subscriptions
object
4 properties
ImplicitlyOrExplicitlyReachable
object
1 property
1 required
GetPushTokenResponseCollection
object
2 properties
1 required
ProfilePartialUpdateQuery
object
1 property
1 required
ErrorSource
object
1 property
PushSubscriptionParameters
object
3 properties
1 required
GetProfileBulkImportJobProfilesRelationshipsResponseCollection
object
2 properties
1 required
AlltimeDateFilter
object
2 properties
2 required
SMSMarketing
object
6 properties
2 required
ProfileRegionCondition
object
3 properties
3 required
SegmentResponseObjectResource
object
5 properties
4 required
LessThanPositiveNumericFilter
object
3 properties
3 required
PatchIdentifiers
object
2 properties
PushTokenCreateQueryResourceObject
object
2 properties
2 required
ProfileResponseObjectResource
object
5 properties
3 required
CustomSourceFilter
object
2 properties
2 required
SMSChannel
object
2 properties
ProfileMetricFunnelSteps
object
3 properties
2 required
ProfileUpsertQuery
object
1 property
1 required
HasEmailMarketing
object
2 properties
1 required
GetProfileResponseCollectionCompoundDocument
object
3 properties
1 required
SubscriptionChannels
object
4 properties
NoSMSMarketing
object
1 property
1 required
OneClickUnsubscribeMethodFilter
object
2 properties
2 required
ProfileNoGroupMembershipCondition
object
3 properties
3 required
SegmentDefinition
object
1 property
1 required
ProvidedLandlineMethodFilter
object
2 properties
2 required
PatchProfileResponse
object
2 properties
1 required
ManualRemoveMethodFilter
object
2 properties
2 required
SegmentEnum
string
NoEmailMarketingSubscribed
object
2 properties
2 required
ListSubstringFilter
object
3 properties
3 required
PostProfileImportJobResponse
object
2 properties
1 required
FormMethodFilter
object
3 properties
2 required
GetPushTokenResponseCompoundDocument
object
3 properties
1 required
ConversationEnum
string
ProfilePredictiveAnalyticsDateCondition
object
3 properties
3 required
InboundMessageMethodFilter
object
2 properties
2 required
GetProfileImportJobResponseCollectionCompoundDocument
object
2 properties
1 required
IntegerFilter
object
3 properties
3 required
NoEmailMarketingConsent
object
3 properties
3 required
PushTokenCreateQuery
object
1 property
1 required
ProfileLocation
object
10 properties
ProfileBulkImportJobEnum
string
ProfilePermissionsCondition
object
3 properties
3 required
ManualImportManualMethodFilter
object
3 properties
2 required
StringPhoneOperatorStringArrayFilter
object
3 properties
3 required
ManualAddManualMethodFilter
object
3 properties
2 required
ProfileSuppressionCreateQueryResourceObject
object
2 properties
2 required
GetImportErrorResponseCollection
object
2 properties
1 required
IsSetExistenceFilter
object
2 properties
2 required
ProfileSubscriptionCreateQueryResourceObject
object
3 properties
2 required
SegmentsProfileMetricCondition
object
6 properties
5 required
CalendarDateFilter
object
3 properties
3 required
GetBulkProfileSuppressionsRemoveJobResponseCollection
object
2 properties
1 required
GetProfileResponseCollection
object
2 properties
1 required
NoPushMarketing
object
1 property
1 required
SubscriptionDeleteJobCreateQuery
object
1 property
1 required
PreferencePageMethodFilter
object
2 properties
2 required
ProfileSubscriptionDeleteQueryResourceObject
object
2 properties
2 required
BulkRemoveMethodFilter
object
2 properties
2 required
SegmentsProfileMetricFunnelCondition
object
4 properties
3 required
ProfilePostalCodeDistanceCondition
object
5 properties
5 required
HasSMSMarketingSubscribed
object
2 properties
1 required
ProfilePredictiveAnalyticsStringCondition
object
3 properties
3 required
ProfileImportJobCreateQuery
object
1 property
1 required
RelativeDateOperatorBaseRelativeDateFilter
object
4 properties
4 required
ExistenceOperatorExistenceFilter
object
2 properties
2 required
BackInStockMethodFilter
object
2 properties
2 required
ListContainsOperatorListContainsFilter
object
3 properties
3 required
EmailMarketingListSuppression
object
3 properties
3 required
ProfileImportJobCreateQueryResourceObject
object
3 properties
2 required
ProfilePredictiveAnalyticsNumericCondition
object
3 properties
3 required
ProfileMergeEnum
string
StringOperatorStringFilter
object
3 properties
3 required
GetConversationResponse
object
2 properties
1 required
ManualSuppressionDateFilter
object
2 properties
2 required
GetProfileSegmentsRelationshipsResponseCollection
object
2 properties
1 required
PushTokenDeviceMetadata
object
12 properties
SubscriptionDeleteJobCreateQueryResourceObject
object
3 properties
2 required
ShopifyIntegrationMethodFilter
object
3 properties
3 required
SubscriptionCreateJobCreateQuery
object
1 property
1 required
UnsubscriptionParameters
object
1 property
1 required
RelativeDateRangeFilter
object
5 properties
5 required
PostProfileResponse
object
2 properties
1 required
HasEmailMarketingSubscribed
object
2 properties
1 required
MailboxProviderMethodFilter
object
2 properties
2 required
AnniversaryDateFilter
object
2 properties
2 required
ListSetFilter
object
3 properties
3 required
PushProfileUpsertQueryResourceObject
object
3 properties
2 required
DeviceMetadata
object
12 properties
ProfileMetricPropertyFilter
object
2 properties
1 required
GetProfileResponseCompoundDocument
object
3 properties
1 required
ProfileImportJobResponseObjectResource
object
5 properties
4 required
ConditionGroup
object
1 property
1 required
GetSegmentResponseCollection
object
2 properties
1 required
GetProfilePushTokensRelationshipsResponseCollection
object
2 properties
1 required
InStringArrayFilter
object
3 properties
3 required
NoSMSMarketingNeverSubscribed
object
1 property
1 required
EmailSubscriptionParameters
object
1 property
1 required
WhatsAppSubscriptionParameters
object
2 properties
GreaterThanPositiveNumericFilter
object
3 properties
3 required
EmailMarketingSuppression
object
2 properties
2 required
SubscriptionParameters
object
2 properties
1 required
NumericOperatorNumericFilter
object
3 properties
3 required
ProfilePredictiveAnalyticsChannelAffinityRankCondition
object
5 properties
5 required
CollectionLinks
object
5 properties
1 required
HasSMSMarketingConsent
object
3 properties
3 required
OnlyRelatedLinks
object
1 property
1 required
StringArrayOperatorStringArrayFilter
object
3 properties
3 required
HasEmailMarketingConsent
object
3 properties
3 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Klaviyo 12
Other APIs Klaviyo publishes across the network.
Klaviyo Accounts API
Klaviyo Campaigns API
Klaviyo Catalogs API
Klaviyo Client API
Klaviyo Conversations API
Klaviyo Coupons API
Klaviyo Custom Objects API
Klaviyo Data Privacy API
Klaviyo Events API
Klaviyo Flows API
Klaviyo Forms API
Klaviyo Images API
#Profiles