customers
List Customers Route
get/api/v1/customers
Query parameters
healthstring[] nullable
lifecycle_stagestring nullable
plan_tierstring nullable
plan_namestring nullable
billing_statusstring nullable
paying | subscriber | cancelled
paying | subscriber | cancelled
searchstring nullable
sortstring
sort_dirstring
min_churn_risknumber nullable
max_churn_risknumber nullable
min_actionsinteger nullable
signup_afterstring nullable
YYYY-MM-DD, inclusive
YYYY-MM-DD, inclusive
signup_beforestring nullable
YYYY-MM-DD, inclusive
YYYY-MM-DD, inclusive
facetstring nullable
facet_valuestring nullable
min_confidencenumber nullable
paginatestring
offset | cursor
offset | cursor
cursorstring nullable
limitinteger
ph_keysstring[] nullable
PostHog property keys to include
PostHog property keys to include
pageinteger
Page number
Page number
per_pageinteger
Items per page
Items per page
Headers
authorizationstring nullable
Bearer <token>
Bearer <token>
Response
Successful Response
Changes
No recorded changes to this endpoint across all 1 revision of this API.