Get the segments of a profile
https://email.growthdept.ai/api/profiles/{id}/segmentsRate limits
Scopes
profiles:readsegments:read
Operation id
get_segments_for_profile The same operation as in Klaviyo's API. OpenAPI document
Path parameters
stringrequired
Query parameters
Pick values to add them to the request:
Headers
stringrequireddefault 2026-10-15
API revision, YYYY-MM-DD. This server implements 2026-10-15.
Responses
200Success
Response body
object
dataarray of objectsrequired
data: 5 fields
typestringrequired
segmentidstringrequired
attributesobjectrequired
attributes: 7 fields
namestringcan be null
definitionobjectcan be null
definition: 1 field
condition_groupsarray of objectsrequired
condition_groups: 1 field
conditionsarray of objectsrequired
One option: ProfileHasGroupMembershipCondition
typestringrequired
profile-group-membershipis_memberbooleanrequired
truegroup_idsarray of stringsrequired
timeframe_filterone ofcan be null
One option: StaticDateFilter
typestringrequired
dateoperatorstringrequired
afterbeforedatestring (date-time)required
One option: StaticDateRangeFilter
typestringrequired
dateoperatorstringrequired
between-staticstartstring (date-time)required
endstring (date-time)required
One option: RelativeDateOperatorBaseRelativeDateFilter
typestringrequired
dateoperatorstringrequired
at-leastin-the-lastin-the-nextunitstringrequired
dayhourweekquantityintegerrequired
One option: RelativeDateRangeFilter
typestringrequired
dateoperatorstringrequired
betweenstartintegerrequired
endintegerrequired
unitstringrequired
dayhourweek
One option: ProfileNoGroupMembershipCondition
typestringrequired
profile-group-membershipis_memberbooleanrequired
falsegroup_idsarray of stringsrequired
One option: SegmentsProfileMetricCondition
typestringrequired
profile-metricmetric_idstringrequired
measurementstringrequired
countsummeasurement_filterobjectrequired
measurement_filter: 3 fields
typestringrequired
numericoperatorstringrequired
equalsgreater-thangreater-than-or-equalless-thanless-than-or-equalnot-equalsvalueobjectrequired
timeframe_filterone ofrequired
One option: StaticDateFilter
typestringrequired
dateoperatorstringrequired
afterbeforedatestring (date-time)required
One option: StaticDateRangeFilter
typestringrequired
dateoperatorstringrequired
between-staticstartstring (date-time)required
endstring (date-time)required
One option: RelativeDateOperatorBaseRelativeDateFilter
typestringrequired
dateoperatorstringrequired
at-leastin-the-lastin-the-nextunitstringrequired
dayhourweekquantityintegerrequired
One option: RelativeAnniversaryDateFilter
typestringrequired
dateoperatorstringrequired
anniversary-lastanniversary-nextunitstringrequired
dayhourweekquantityintegerrequired
One option: RelativeDateRangeFilter
typestringrequired
dateoperatorstringrequired
betweenstartintegerrequired
endintegerrequired
unitstringrequired
dayhourweek
One option: AlltimeDateFilter
typestringrequired
dateoperatorstringrequired
alltime
metric_filtersarray of objectscan be null
metric_filters: 2 fields
propertystringrequired
filterobjectrequired
One option: ProfileMarketingConsentCondition
typestringrequired
profile-marketing-consentconsentone ofrequired
One option: HasEmailMarketingConsent
channelstringrequired
emailcan_receive_marketingbooleanrequired
trueconsent_statusobjectrequired
One option: NoEmailMarketingConsent
channelstringrequired
emailcan_receive_marketingbooleanrequired
falseconsent_statusobjectrequired
One option: HasSMSMarketingConsent
channelstringrequired
smscan_receive_marketingbooleanrequired
trueconsent_statusobjectrequired
One option: NoSMSMarketingConsent
channelstringrequired
smscan_receive_marketingbooleanrequired
falseconsent_statusobjectrequired
One option: HasPushMarketingConsent
channelstringrequired
pushcan_receive_marketingbooleanrequired
trueconsent_statusobjectrequired
One option: NoPushMarketingConsent
channelstringrequired
pushcan_receive_marketingbooleanrequired
falseconsent_statusobjectrequired
One option: ProfilePostalCodeDistanceCondition
typestringrequired
profile-postal-code-distancecountry_codestringrequired
postal_codestringrequired
unitstringrequired
kilometersmilesfilterone ofrequired
One option: GreaterThanPositiveNumericFilter
typestringrequired
numericoperatorstringrequired
greater-thanvalueobjectrequired
One option: LessThanPositiveNumericFilter
typestringrequired
numericoperatorstringrequired
less-thanvalueobjectrequired
One option: ProfilePropertyCondition
typestringrequired
profile-propertypropertystringrequired
filterone ofrequired
One option: StringOperatorStringFilter
typestringrequired
stringoperatorstringrequired
containsends-withequalsnot-containsnot-ends-withnot-equalsnot-starts-withnregexregexstarts-withvaluestringrequiredcan be null
One option: StringArrayOperatorStringArrayFilter
typestringrequired
stringoperatorstringrequired
innot-invaluearray of stringsrequired
One option: StringPhoneOperatorStringArrayFilter
typestringrequired
stringoperatorstringrequired
phone-country-code-inphone-country-code-not-invaluearray of stringsrequired
One option: NumericOperatorNumericFilter
typestringrequired
numericoperatorstringrequired
equalsgreater-thangreater-than-or-equalless-thanless-than-or-equalnot-equalsvalueobjectrequired
One option: BooleanFilter
typestringrequired
booleanoperatorstringrequired
equalsvaluebooleanrequired
One option: StaticDateFilter
typestringrequired
dateoperatorstringrequired
afterbeforedatestring (date-time)required
One option: StaticDateRangeFilter
typestringrequired
dateoperatorstringrequired
between-staticstartstring (date-time)required
endstring (date-time)required
One option: RelativeDateOperatorBaseRelativeDateFilter
typestringrequired
dateoperatorstringrequired
at-leastin-the-lastin-the-nextunitstringrequired
dayhourweekquantityintegerrequired
One option: RelativeAnniversaryDateFilter
typestringrequired
dateoperatorstringrequired
anniversary-lastanniversary-nextunitstringrequired
dayhourweekquantityintegerrequired
One option: RelativeDateRangeFilter
typestringrequired
dateoperatorstringrequired
betweenstartintegerrequired
endintegerrequired
unitstringrequired
dayhourweek
One option: CalendarDateFilter
typestringrequired
dateoperatorstringrequired
calendar-monthvalueintegerrequired
One option: AnniversaryDateFilter
typestringrequired
dateoperatorstringrequired
anniversaryanniversary-month
One option: ListContainsOperatorListContainsFilter
typestringrequired
listoperatorstringrequired
containsnot-containsvalueobjectrequiredcan be null
One option: ListLengthFilter
typestringrequired
listoperatorstringrequired
length-equalslength-greater-thanlength-greater-than-or-equallength-less-thanlength-less-than-or-equalvalueintegerrequired
One option: ExistenceOperatorExistenceFilter
typestringrequired
existenceoperatorstringrequired
is-setnot-set
One option: ProfileRegionCondition
typestringrequired
profile-regionin_regionbooleanrequired
regionstringrequired
european_unionunited_states
One option: ProfilePredictiveAnalyticsDateCondition
dimensionstringrequired
expected_date_of_next_purchasefilterone ofrequired
One option: StaticDateFilter
typestringrequired
dateoperatorstringrequired
afterbeforedatestring (date-time)required
One option: StaticDateRangeFilter
typestringrequired
dateoperatorstringrequired
between-staticstartstring (date-time)required
endstring (date-time)required
One option: RelativeDateOperatorBaseRelativeDateFilter
typestringrequired
dateoperatorstringrequired
at-leastin-the-lastin-the-nextunitstringrequired
dayhourweekquantityintegerrequired
One option: RelativeAnniversaryDateFilter
typestringrequired
dateoperatorstringrequired
anniversary-lastanniversary-nextunitstringrequired
dayhourweekquantityintegerrequired
One option: RelativeDateRangeFilter
typestringrequired
dateoperatorstringrequired
betweenstartintegerrequired
endintegerrequired
unitstringrequired
dayhourweek
One option: CalendarDateFilter
typestringrequired
dateoperatorstringrequired
calendar-monthvalueintegerrequired
One option: AnniversaryDateFilter
typestringrequired
dateoperatorstringrequired
anniversaryanniversary-month
typestringrequired
profile-predictive-analytics
One option: ProfilePredictiveAnalyticsNumericCondition
typestringrequired
profile-predictive-analyticsdimensionstringrequired
average_days_between_ordersaverage_order_valuechurn_probabilityhistoric_clvhistoric_number_of_orderspredicted_clvpredicted_number_of_orderstotal_clvfilterobjectrequired
filter: 3 fields
typestringrequired
numericoperatorstringrequired
equalsgreater-thangreater-than-or-equalless-thanless-than-or-equalnot-equalsvalueobjectrequired
One option: ProfilePredictiveAnalyticsStringCondition
typestringrequired
profile-predictive-analyticsdimensionstringrequired
predicted_genderfilterobjectrequired
filter: 3 fields
typestringrequired
stringoperatorobjectrequired
valuestringrequired
likely_femalelikely_maleuncertain
One option: ProfilePredictiveAnalyticsChannelAffinityPriorityCondition
typestringrequired
profile-predictive-analyticsdimensionstringrequired
channel_affinitymeasurementstringrequired
prioritypredicted_channelstringrequired
emailpushsmswhatsappfilterobjectrequired
filter: 3 fields
typestringrequired
numericoperatorstringrequired
equalsvalueintegerrequired
One option: ProfilePredictiveAnalyticsChannelAffinityRankCondition
typestringrequired
profile-predictive-analyticsdimensionstringrequired
channel_affinitymeasurementstringrequired
rankpredicted_channelstringrequired
emailpushsmswhatsappfilterobjectrequired
filter: 3 fields
typestringrequired
stringoperatorobjectrequired
valuestringrequired
highlowmedium
One option: ProfileHasCustomObjectCondition
typestringrequired
profile-has-custom-objectobject_type_idstringrequired
object_type_relationship_idstringrequired
filterobjectrequired
filter: 3 fields
typestringrequired
numericoperatorstringrequired
equalsgreater-thangreater-than-or-equalless-thanless-than-or-equalnot-equalsvalueintegerrequired
filtersarray of objectsrequired
filters: 2 fields
property_idintegerrequired
filterobjectrequired
One option: ProfilePermissionsCondition
typestringrequired
profile-permissionspermissionone ofrequired
One option: ExplicitlyReachable
reachable_statusstringrequired
explicitly_reachablefiltersarray of objectsrequired
One option: ImplicitlyReachable
reachable_statusstringrequired
implicitly_reachable
One option: ImplicitlyOrExplicitlyReachable
reachable_statusstringrequired
implicitly_or_explicitly_reachable
One option: ExplicitlyUnreachable
reachable_statusstringrequired
explicitly_unreachablefiltersarray of objectsrequired
One option: ImplicitlyUnreachable
reachable_statusstringrequired
implicitly_unreachable
One option: ImplicitlyOrExplicitlyUnreachable
reachable_statusstringrequired
implicitly_or_explicitly_unreachable
channelstringrequired
email_click_trackingemail_open_trackingwhatsapp_marketingwhatsapp_transactional
One option: SegmentsProfileMetricFunnelCondition
typestringrequired
profile-metric-funneltimeframe_filterone ofrequired
One option: StaticDateRangeFilter
typestringrequired
dateoperatorstringrequired
between-staticstartstring (date-time)required
endstring (date-time)required
One option: RelativeDateRangeFilter
typestringrequired
dateoperatorstringrequired
betweenstartintegerrequired
endintegerrequired
unitstringrequired
dayhourweek
One option: RelativeDateOperatorBaseRelativeDateFilter
typestringrequired
dateoperatorstringrequired
at-leastin-the-lastin-the-nextunitstringrequired
dayhourweekquantityintegerrequired
completion_window_secondsstringcan be null
DAYS_1DAYS_180DAYS_3DAYS_30DAYS_5DAYS_90HOURS_1WEEKS_1YEARS_1stepsarray of objectsrequired
steps: 3 fields
metric_existsbooleanrequired
metric_idstringrequired
metric_filtersarray of objectscan be null
createdstring (date-time)can be null
updatedstring (date-time)can be null
is_activebooleanrequired
is_processingbooleanrequired
is_starredbooleanrequired
relationshipsobject
relationships: 3 fields
profilesobject
profiles: 2 fields
dataarray of objects
data: 2 fields
typestringrequired
profileidstringrequired
linksobject
links: 2 fields
selfstring (uri)required
relatedstring (uri)required
tagsobject
tags: 2 fields
dataarray of objects
data: 2 fields
typestringrequired
tagidstringrequired
linksobject
links: 2 fields
selfstring (uri)required
relatedstring (uri)required
flow-triggersobject
flow-triggers: 2 fields
dataarray of objects
data: 2 fields
typestringrequired
flowidstringrequired
linksobject
links: 2 fields
selfstring (uri)required
relatedstring (uri)required
linksobjectrequired
links: 1 field
selfstring (uri)required
linksobject
links: 3 fields
selfstring (uri)required
prevstring (uri)
nextstring (uri)
metaobject
4XXClient error
Response body
object
errorsarray of objectsrequired
errors: 8 fields
idstringrequired
statusintegerrequired
codestringrequired
titlestringrequired
detailstringrequired
sourceobject
source: 2 fields
pointerstring
parameterstring
linksobject
metaobject
See status codes for each code.
5XXServer error
Response body
object
errorsarray of objectsrequired
errors: 8 fields
idstringrequired
statusintegerrequired
codestringrequired
titlestringrequired
detailstringrequired
sourceobject
source: 2 fields
pointerstring
parameterstring
linksobject
metaobject