GWM structure
GET/GWM/{id}
MCP tool
get_gwm_structureFull license onlyReturns the nodes of a client's Global Wealth Map: owners, entities, investment vehicles and accounts, with ownership percentages and valuations. Use parentNodeId to rebuild the tree.
Parameters
| Name | In | Type | Description | |
|---|---|---|---|---|
id | path | integer | required | Client id. 0 is not supported on this endpoint. |
ccy | query | string | optional | Currency for valuation, for example USD. |
status | query | integer | optional | Omit for active nodes only. 1 returns only removed nodes. 2 returns active and removed nodes. |
tenantId | query | string | optional | Tenant to query, from /Tenants. Default: your user's main tenant. |
Example request
Response
| Field | Type | Description |
|---|---|---|
nodeId | string | Node id, {nodeType}_{id}. |
name | string | Node name in GWM. |
alias | string | Node alias in GWM. |
bankBroker | string | Bank or broker assigned to the node. |
accountNumber | string | Account number, for account nodes. |
ownershipPct | number | null | Ownership percentage of the node. |
valuation | number | null | Valuation of the node, in ccy. |
parentNodeId | string | Parent node id, {parentType}_{parentId}. |
date | string | Date the request was made. |
groupNodeId | integer | null | Internal group node id. |
status | string | "Active" for current nodes. Removed nodes (returned with status=1 or 2) carry a different value. |
Errors
| Status | Body |
|---|---|
400 | "The user does not have access to this client or the client does not exist." Also returned for id=0. |
400 | "The user does not have access to this tenant or the tenant does not exist." |
Plus the common 401 and 429 responses. See Errors.