Retrieve reset status
curl --request GET \
--url https://app.sure.am/api/v1/users/reset/status \
--header 'X-Api-Key: <api-key>'import requests
url = "https://app.sure.am/api/v1/users/reset/status"
headers = {"X-Api-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};
fetch('https://app.sure.am/api/v1/users/reset/status', 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://app.sure.am/api/v1/users/reset/status",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-Api-Key: <api-key>"
],
]);
$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://app.sure.am/api/v1/users/reset/status"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Api-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.sure.am/api/v1/users/reset/status")
.header("X-Api-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.sure.am/api/v1/users/reset/status")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Api-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"status": "complete",
"family_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"reset_complete": true,
"counts": {
"account_statements": 1,
"family_exports": 1,
"imports": 1,
"import_sessions": 1,
"import_source_mappings": 1,
"import_rows": 1,
"import_mappings": 1,
"accounts": 1,
"account_shares": 1,
"account_providers": 1,
"entries": 1,
"transactions": 1,
"transfers": 1,
"rejected_transfers": 1,
"valuations": 1,
"trades": 1,
"holdings": 1,
"balances": 1,
"recurring_transactions": 1,
"rules": 1,
"rule_actions": 1,
"rule_conditions": 1,
"rule_runs": 1,
"budgets": 1,
"budget_categories": 1,
"categories": 1,
"tags": 1,
"taggings": 1,
"merchants": 1,
"family_merchant_associations": 1,
"provider_items": 1,
"active_storage_attachments": 1,
"plaid_items": 1
}
}{
"error": "<string>",
"message": "<string>",
"details": [
"<string>"
],
"errors": [
"<string>"
]
}{
"error": "<string>",
"message": "<string>",
"details": [
"<string>"
],
"errors": [
"<string>"
]
}Users
Retrieve reset status
Returns counts of family-owned data targeted by account reset. Use this after DELETE /api/v1/users/reset to decide whether reset materialization has completed. Completion is a counts-based family snapshot and may change if new data is created after reset.
GET
/
api
/
v1
/
users
/
reset
/
status
Retrieve reset status
curl --request GET \
--url https://app.sure.am/api/v1/users/reset/status \
--header 'X-Api-Key: <api-key>'import requests
url = "https://app.sure.am/api/v1/users/reset/status"
headers = {"X-Api-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};
fetch('https://app.sure.am/api/v1/users/reset/status', 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://app.sure.am/api/v1/users/reset/status",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-Api-Key: <api-key>"
],
]);
$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://app.sure.am/api/v1/users/reset/status"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Api-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.sure.am/api/v1/users/reset/status")
.header("X-Api-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.sure.am/api/v1/users/reset/status")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Api-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"status": "complete",
"family_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"reset_complete": true,
"counts": {
"account_statements": 1,
"family_exports": 1,
"imports": 1,
"import_sessions": 1,
"import_source_mappings": 1,
"import_rows": 1,
"import_mappings": 1,
"accounts": 1,
"account_shares": 1,
"account_providers": 1,
"entries": 1,
"transactions": 1,
"transfers": 1,
"rejected_transfers": 1,
"valuations": 1,
"trades": 1,
"holdings": 1,
"balances": 1,
"recurring_transactions": 1,
"rules": 1,
"rule_actions": 1,
"rule_conditions": 1,
"rule_runs": 1,
"budgets": 1,
"budget_categories": 1,
"categories": 1,
"tags": 1,
"taggings": 1,
"merchants": 1,
"family_merchant_associations": 1,
"provider_items": 1,
"active_storage_attachments": 1,
"plaid_items": 1
}
}{
"error": "<string>",
"message": "<string>",
"details": [
"<string>"
],
"errors": [
"<string>"
]
}{
"error": "<string>",
"message": "<string>",
"details": [
"<string>"
],
"errors": [
"<string>"
]
}Authorizations
API key for authentication. Generate one from your account settings.
Response
reset status returned
Counts-based family reset status at response time.
Available options:
complete, data_remaining UUID of the family whose reset target counts were checked.
True when all reset target counts are zero at response time. This is a family data snapshot, not a durable per-job completion record.
Show child attributes
Show child attributes
Was this page helpful?
⌘I