Skip to main content
GET
/
v2
/
partner
/
summary
Get Portfolio Summary
curl --request GET \
  --url https://api.trykintsugi.com/v2/partner/summary \
  --header 'X-API-KEY: <api-key>'
{
  "totalClients": 123,
  "totalFilings": 123,
  "filedCount": 123,
  "pendingApproval": 123,
  "overdueCount": 123,
  "totalLiability": "<string>"
}

Authorizations

​
X-API-KEY
string
header
required

Headers

​
x-partner-id
string | null

Target partner. Required for referral partner API keys (selects the owned sub-partner; omitting it returns 400 PARTNER_ID_REQUIRED). For multi-partner bearer users, selects the active partner.

Maximum string length: 100

Query Parameters

​
filter_user_id
string | null

Scope results to a specific team member's assigned orgs. Use "me" to filter to the caller's own assignments, or pass a user id (the row id from GET /partner/users). Ignored for MEMBER-role users who are always scoped to their own assignments. Fail-closed: if the target is not an ACTIVE member of this partner's org, the response will contain zeroed/empty data (not a 4xx error).

Maximum string length: 100
Pattern: ^(me|[A-Za-z0-9_-]+)$

Response

Successful Response

Aggregated summary across all partner client organizations.

​
totalClients
integer
required
​
totalFilings
integer
required
​
filedCount
integer
required
​
pendingApproval
integer
required
​
overdueCount
integer
required
​
totalLiability
string
required
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$