API

Get investment group

Get one investment group (metadata only).

Metadata only — use list_investments for holdings. Pass source: "bank" for attached bank groups (groupId = connectionId).

GET/v1/get_investment_group

Query

FieldTypeRequiredDefaultDescription
budgetIdstringYes—Budget that owns the group.
groupIdstringYes—Manual group id, or bank connectionId when source is bank.
sourcestringNomanualmanual (default) or bank for attached bank groups.

Response data

FieldTypeDescription
idstringId of the investment group.
sourcestringmanual or bank.
groupKeystringStable key used when reordering (manual:).
namestringDisplay name.
connectionIdstringPresent for bank groups.
institutionLabelstringPresent for bank groups.
linkedByUidstringPresent for bank groups when attached by a collaborator.
holdingCountnumberPresent for bank groups (count of synced holdings).
ownerUidstringPresent for manual groups when set.
ownerDisplayNamestringPresent for manual groups when set.