Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Klaviyo Segments 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 Segments. 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 11 operations across 8 paths, and defines 158 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.

11 operations 8 paths 158 schemas 1 DELETE8 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.2
API Version
2026-04-15
Base URL
https://a.klaviyo.com
Authentication
API Key
License
Terms of Service
Resource Areas
1

Authentication & Security 1

Klaviyo Segments 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 11

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

Segments 11

segments

GET
/api/segments
Get Segments
get_segments 9 params → 2004XX5XX
POST
/api/segments
Create Segment
create_segment 1 param body → 2014XX5XX
GET
/api/segments/{id}
Get Segment
get_segment 7 params → 2004XX5XX
PATCH
/api/segments/{id}
Update Segment
update_segment 2 params body → 2004XX5XX
DELETE
/api/segments/{id}
Delete Segment
delete_segment 2 params → 2044XX5XX
GET
/api/segments/{id}/tags
Get Tags for Segment
get_tags_for_segment 3 params → 2004XX5XX
GET
/api/segments/{id}/relationships/tags
Get Tag IDs for Segment
get_tag_ids_for_segment 2 params → 2004XX5XX
GET
/api/segments/{id}/profiles
Get Profiles for Segment
get_profiles_for_segment 8 params → 2004XX5XX
GET
/api/segments/{id}/relationships/profiles
Get Profile IDs for Segment
get_profile_ids_for_segment 6 params → 2004XX5XX
GET
/api/segments/{id}/flow-triggers
Get Flows Triggered by Segment
get_flows_triggered_by_segment 3 params → 2004XX5XX
GET
/api/segments/{id}/relationships/flow-triggers
Get IDs for Flows Triggered by Segment
get_ids_for_flows_triggered_by_segment 2 params → 2004XX5XX

Schemas 158

The contract defines 158 schemas that model the data the API accepts and returns. The most detailed are ProfileLocation (10 properties), PredictiveAnalytics (10 properties), EmailMarketing (10 properties), WhatsappMarketingChannel (8 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
ProfilePredictiveAnalyticsChannelAffinityPriorityCondition
object
5 properties 5 required
GetTagResponseCollection
object
2 properties 1 required
ListEnum
string
StatusDateFilter
object
2 properties 2 required
PredictiveAnalytics
object
10 properties
PushChannel
object
1 property
HasPushMarketingConsent
object
3 properties 3 required
ProfileEnum
string
ProfileModificationMethodFilter
object
2 properties 2 required
CheckoutMethodFilter
object
2 properties 2 required
PushMarketing
object
3 properties 2 required
WhatsappMarketingChannel
object
8 properties 3 required
RelativeAnniversaryDateFilter
object
4 properties 4 required
ProfilePredictiveAnalyticsStringFilter
object
3 properties 3 required
ShopifyIntegrationFilter
object
3 properties 3 required
DoubleOptinFilter
object
2 properties 2 required
ExplicitlyUnreachable
object
2 properties 2 required
ProfileMarketingConsentCondition
object
2 properties 2 required
NoSMSMarketingUnsubscribed
object
2 properties 1 required
PreferencePageFilter
object
3 properties 2 required
ObjectLinks
object
1 property 1 required
MethodFilter
object
2 properties 2 required
GetSegmentProfilesRelationshipsResponseCollection
object
2 properties 1 required
TagEnum
string
GetSegmentFlowTriggersRelationshipsResponseCollection
object
2 properties 1 required
FailedAgeGateMethodFilter
object
2 properties 2 required
ProfileHasCustomObjectFilter
object
2 properties 2 required
ConstantContactIntegrationMethodFilter
object
3 properties 3 required
GetSegmentRetrieveResponseCompoundDocument
object
3 properties 1 required
PushTokenEnum
string
HasEmailMarketingNeverSubscribed
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
SubscribedSMSIsRcsCapableFilter
object
2 properties 2 required
GetSegmentTagsRelationshipsResponseCollection
object
2 properties 1 required
SegmentCreateQuery
object
1 property 1 required
APIMethodFilter
object
3 properties 2 required
StaticDateFilter
object
3 properties 3 required
ExplicitlyReachable
object
2 properties 2 required
ListLengthFilter
object
3 properties 3 required
GetSegmentMemberResponseCollection
object
2 properties 1 required
RecordedDateFilter
object
2 properties 2 required
SftpMethodFilter
object
2 properties 2 required
InvalidEmailDateFilter
object
2 properties 2 required
WhatsappChannel
object
3 properties
CarrierDeactivationMethodFilter
object
2 properties 2 required
HasPushMarketing
object
2 properties 1 required
ImplicitlyReachable
object
1 property 1 required
EffectiveDateFilter
object
2 properties 2 required
SpamComplaintMethodFilter
object
2 properties 2 required
FlowEnum
string
CampaignEnum
string
EmailChannel
object
1 property
DataWarehouseImportMethodFilter
object
2 properties 2 required
EqualsStringFilter
object
3 properties 3 required
PostSegmentCreateResponse
object
2 properties 1 required
BooleanFilter
object
3 properties 3 required
ProfilePredictiveAnalyticsChannelAffinityRankFilter
object
3 properties 3 required
ManualImportMethodFilter
object
2 properties 2 required
SegmentMemberResponseObjectResource
object
5 properties 3 required
WhatsappConversationalChannel
object
8 properties 3 required
ProfilePredictiveAnalyticsChannelAffinityPriorityFilter
object
3 properties 3 required
ProfileHasCustomObjectCondition
object
5 properties 5 required
SegmentPartialUpdateQuery
object
1 property 1 required
FlowActionEnum
string
ImplicitlyUnreachable
object
1 property 1 required
ProfilePropertyCondition
object
3 properties 3 required
NoEmailMarketingUnsubscribed
object
2 properties 1 required
RelationshipLinks
object
2 properties 2 required
BounceDateFilter
object
2 properties 2 required
NoEmailMarketing
object
2 properties 1 required
ImplicitlyOrExplicitlyUnreachable
object
1 property 1 required
NoPushMarketingConsent
object
3 properties 3 required
SMSTransactional
object
6 properties 2 required
EmailMarketing
object
10 properties 2 required
StaticDateRangeFilter
object
4 properties 4 required
ProfileHasGroupMembershipCondition
object
4 properties 3 required
WhatsappTransactionalChannel
object
8 properties 3 required
FlowResponseObjectResource
object
5 properties 4 required
SegmentCreateQueryResourceObject
object
2 properties 2 required
SegmentListResponseObjectResource
object
5 properties 4 required
GetFlowResponseCollection
object
2 properties 1 required
Subscriptions
object
4 properties
ImplicitlyOrExplicitlyReachable
object
1 property 1 required
SegmentRetrieveResponseObjectResource
object
5 properties 4 required
AlltimeDateFilter
object
2 properties 2 required
SMSMarketing
object
6 properties 2 required
ProfileRegionCondition
object
3 properties 3 required
LessThanPositiveNumericFilter
object
3 properties 3 required
CustomSourceFilter
object
2 properties 2 required
SMSChannel
object
2 properties
TagResponseObjectResource
object
5 properties 4 required
ProfileMetricFunnelSteps
object
3 properties 2 required
HasEmailMarketing
object
2 properties 1 required
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
ManualRemoveMethodFilter
object
2 properties 2 required
SegmentEnum
string
NoEmailMarketingSubscribed
object
2 properties 2 required
ListSubstringFilter
object
3 properties 3 required
FormMethodFilter
object
3 properties 2 required
TagGroupEnum
string
GetSegmentListResponseCollectionCompoundDocument
object
3 properties 1 required
ProfilePredictiveAnalyticsDateCondition
object
3 properties 3 required
InboundMessageMethodFilter
object
2 properties 2 required
IntegerFilter
object
3 properties 3 required
NoEmailMarketingConsent
object
3 properties 3 required
ManualImportManualMethodFilter
object
3 properties 2 required
ProfilePermissionsCondition
object
3 properties 3 required
ProfileLocation
object
10 properties
ManualAddManualMethodFilter
object
3 properties 2 required
StringPhoneOperatorStringArrayFilter
object
3 properties 3 required
IsSetExistenceFilter
object
2 properties 2 required
SegmentsProfileMetricCondition
object
6 properties 5 required
CalendarDateFilter
object
3 properties 3 required
NoPushMarketing
object
1 property 1 required
PreferencePageMethodFilter
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
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
ProfilePredictiveAnalyticsNumericCondition
object
3 properties 3 required
StringOperatorStringFilter
object
3 properties 3 required
PatchSegmentPartialUpdateResponse
object
2 properties 1 required
ManualSuppressionDateFilter
object
2 properties 2 required
ShopifyIntegrationMethodFilter
object
3 properties 3 required
RelativeDateRangeFilter
object
5 properties 5 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
SegmentPartialUpdateQueryResourceObject
object
3 properties 3 required
ProfileMetricPropertyFilter
object
2 properties 1 required
ConditionGroup
object
1 property 1 required
InStringArrayFilter
object
3 properties 3 required
NoSMSMarketingNeverSubscribed
object
1 property 1 required
GreaterThanPositiveNumericFilter
object
3 properties 3 required
EmailMarketingSuppression
object
2 properties 2 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
StringArrayOperatorStringArrayFilter
object
3 properties 3 required
HasEmailMarketingConsent
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

klaviyo-segments-api-openapi.yml Raw ↑

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