Skip to main content
GET
/
v2
/
partner
/
clients
Get Portfolio Clients
curl --request GET \
  --url https://api.trykintsugi.com/v2/partner/clients \
  --header 'X-API-KEY: <api-key>'
{
  "items": [
    {
      "id": "<string>",
      "name": "<string>",
      "totalFilings": 123,
      "filed": 123,
      "pendingApproval": 123,
      "overdue": 123,
      "totalLiability": "<string>"
    }
  ],
  "total": 1,
  "page": 2,
  "size": 2,
  "pages": 1
}

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

​
search
string | null
​
client_id
string | null
​
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_-]+)$
​
page
integer
default:1

Page number

Required range: x >= 1
​
size
integer
default:50

Page size

Required range: 1 <= x <= 100

Response

Successful Response

​
items
PartnerClient · object[]
required
​
total
integer
required
Required range: x >= 0
​
page
integer
required
Required range: x >= 1
​
size
integer
required
Required range: x >= 1
​
pages
integer
required
Required range: x >= 0