Get account setup
Changed onAudit what the account has and hasn't set up: the onboarding steps with their statuses, plus a summary of what is actually live right now (display types, flow triggers, connected integrations).
The fastest answer to "is this account configured, and what is it using" — the summary names the kinds of display, trigger, and integration in use without paging /v1/displays and /v1/flows. Kinds only: no titles, no ids, no performance. Use those endpoints to name the individual records and /v1/reports/summary for results.
No scope is required — any valid bearer token can call this endpoint.
Request
- Base URLhttps://api.privy.com/v1
- AuthHTTP bearer
Headers
Target a subaccount instead of the main connected account. Pass a subaccount id from get_account's subaccounts list. Only direct subaccounts of the connected account are reachable — omit this for the main account itself.
Response
The account's setup steps and live-configuration summary.
Example response
{
"data": {
"steps": [
{
"key": "connect_store",
"status": "completed"
}
],
"started_at": "2026-05-01T09:00:00Z",
"summary": {
"live_display_types": [
"flyout",
"popup"
],
"flow_triggers_in_use": [
"order_placed",
"customer_subscribed_to_marketing"
],
"connected_integrations": [
"shopify",
"bigcommerce"
]
}
}
}Changes
- warning
added the new
forbiddenenum value to the/response property for the response status - warning
added the new
forbiddenenum value to the/response property for the response status - warning
added the new
segment_builder_requiredenum value to the/response property for the response status - warning
added the new
segment_builder_requiredenum value to the/response property for the response status
- warning
- info
endpoint added
- info