API reference / Customers
Get the state of customers
Which payment providers are connected, when Troopy last read the customers, and whether it still reads the older payments.
/api/v1/customer-settingsOther ways to call it
troopy customers settingstroopy_get_customer_settingsResponse
200 · application/jsondata*object13 properties
connected*booleanWhether a payment provider is connected in the workspace
providers*array<object>The payment providers that Troopy reads customers from, and which of them the workspace connected
3 properties
id*enum<string>stripelemonsqueezypolarpaddledodopayments
name*stringconnected*booleansyncedAt*string | nullWhen Troopy last read the customers
syncing*booleanA read waits or runs now
error*string | nullWhat the last read said, when it failed
customers*integerhistory*enum<string>reading: Troopy still reads the older payments, so revenue is not whole yet
readingdone
activation*array<string>The names of the events that mean a customer began to use the product: goals of the tracking script, events of PostHog, or events of the backend
success*objectSteady use: one of the events, on some days within a window of days
3 properties
events*array<string>The names of the events of steady use. Empty: the activation events
At most 10 items
days*integerOn how many days a customer must do one of them
At least 1 · At most 14
window*integerWithin how many days in a row
At least 1 · At most 60
posthog*booleanTroopy also reads what customers do from the PostHog of the workspace
suggest*booleanA teammate suggests the type and the themes of what customers said. A person accepts each one
product*stringThe name of the product in the questions of the surveys
users*integerThe customers that Troopy knows as users of the product