API

List investment groups

List manual and bank investment groups on a budget.

Returns manual groups and attached bank investment groups. Use groupKey with reorder.

GET/v1/list_investment_groups

Query

FieldTypeRequiredDefaultDescription
budgetIdstringYes—Budget whose investment groups to list.

Response data

FieldTypeDescription
itemsarrayManual groups + attached bank groups.

Item fields

FieldTypeDescription
idstringGroup id (connectionId for bank).
sourcestringmanual or bank.
groupKeystringKey for reorder_investment_groups.
namestringDisplay name (manual name, or bank institution label).
connectionIdstringPresent only for bank-linked groups.
institutionLabelstringPresent only for bank-linked groups.
linkedByUidstringUid of the collaborator who attached a bank group, when applicable.
holdingCountnumberPresent only for bank-linked groups.
ownerUidstringOwner uid when present on manual groups.
ownerDisplayNamestringOwner display name when present on manual groups.
holdingOrderstring[]Ordered holding ids when present on manual groups.
updatedAtstringLast update timestamp when present.