API reference / Customers
List the segments of customers
The saved segments of the workspace: each is some rules that pick customers, such as a plan, a status, where they came from, or a trait that the product gave to identify. A caller sees the shared segments and its own.
get
/api/v1/customer-segmentsOther ways to call it
CLI
troopy customers segmentsMCP tool
troopy_list_customer_segmentsRate limit120 calls in 60 seconds, for each key
Response
200 · application/jsondata*array<object>7 properties
id*stringA 24-character id
name*stringrules*array<object>A customer is in the segment when every rule is true for it
3 properties
field*enum<string>statusplanriskpayingactivatedsteadychannelsourcecountrytrait
keystringFor trait: the name of the trait
values*array<string>The customer has one of these values. For paying, activated and steady: yes or no
At most 20 items
shared*booleantrue: everyone in the workspace sees it. false: only the person who made it
by*objectWho made it
2 properties
type*stringname*string | nullcustomers*integerThe customers in the segment now
createdAt*stringISO 8601 date and time
Errors
401 unauthorizedSend an API key as `Authorization: Bearer tr_live_...`. Create one in Troopy under Settings.
403 forbiddenThe key lacks a scope this operation needs, or its owner lacks the role. detail says which; create a key with the scope, or ask an organization owner or admin.
429 rate_limitedWait the number of seconds in Retry-After, then retry.