curl --request GET \
--url https://api.privy.com/v1/account/setup \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.privy.com/v1/account/setup"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.privy.com/v1/account/setup', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.privy.com/v1/account/setup",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.privy.com/v1/account/setup"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.privy.com/v1/account/setup")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.privy.com/v1/account/setup")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": {
"steps": [
{
"key": "account_created",
"status": "completed",
"required": false
},
{
"key": "connect_store",
"status": "completed",
"required": false
},
{
"key": "verify_contact_email",
"status": "not_started",
"required": true
},
{
"key": "authenticate_sending_domain",
"status": "pending",
"required": true
},
{
"key": "verify_physical_address",
"status": "not_started",
"required": true
}
],
"started_at": "2026-05-01T09:00:00Z",
"completed_at": null,
"summary": {
"live_display_types": [
"flyout",
"popup"
],
"flow_triggers_in_use": [
"order_placed",
"customer_subscribed_to_marketing"
],
"connected_integrations": [
"shopify",
"klaviyo"
]
}
}
}{
"error": {
"code": "unauthorized",
"message": "Bearer token is missing or invalid"
}
}{
"error": {
"code": "rate_limited",
"message": "Rate limit exceeded"
}
}Get account setup
Audit 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.
curl --request GET \
--url https://api.privy.com/v1/account/setup \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.privy.com/v1/account/setup"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.privy.com/v1/account/setup', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.privy.com/v1/account/setup",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.privy.com/v1/account/setup"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.privy.com/v1/account/setup")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.privy.com/v1/account/setup")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": {
"steps": [
{
"key": "account_created",
"status": "completed",
"required": false
},
{
"key": "connect_store",
"status": "completed",
"required": false
},
{
"key": "verify_contact_email",
"status": "not_started",
"required": true
},
{
"key": "authenticate_sending_domain",
"status": "pending",
"required": true
},
{
"key": "verify_physical_address",
"status": "not_started",
"required": true
}
],
"started_at": "2026-05-01T09:00:00Z",
"completed_at": null,
"summary": {
"live_display_types": [
"flyout",
"popup"
],
"flow_triggers_in_use": [
"order_placed",
"customer_subscribed_to_marketing"
],
"connected_integrations": [
"shopify",
"klaviyo"
]
}
}
}{
"error": {
"code": "unauthorized",
"message": "Bearer token is missing or invalid"
}
}{
"error": {
"code": "rate_limited",
"message": "Rate limit exceeded"
}
}Authorizations
Send either an API token or an OAuth access token as
Authorization: Bearer <token>. See the Authentication page for details.
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.
Show child attributes
Show child attributes
Was this page helpful?