VUMI Documentation
  • Introduction
    • 🎉Welcome!
    • ➡️Quick Start
  • Platform
    • App Overview
      • API Products
      • Connections Overview
      • API Configuration
    • Link Overview
      • Link redirects
      • Link parameters
      • Customization
  • General API Resources
    • Authentication
      • API Login
    • Entities
      • List entities for app
    • Connections
      • Exchange public token
      • Get Connection status
      • List all connections
      • List public tokens
      • Delete Connection
    • Investments
      • List investments
    • Webhook
      • Get verification key
  • Aggregation
    • Accounts
      • List accounts
      • List account transactions
    • Portfolios
      • List portfolios
      • List portfolio transactions
      • List portfolio positions
  • Assets Transfer
    • Assets transfer
  • Developer Resources
    • API and Widget Errors
    • Webhooks and security
      • Webhook verification
    • Pagination
    • Tracing requests
Powered by GitBook
On this page
  1. Aggregation
  2. Portfolios

List portfolios

Last updated 11 months ago

Returns the list of every portfolio found in a connection, including inactive portfolios.

Portfolio types

You will find the following portfolio types when using our API:

Type
Description

MIX

A portfolio with investments of multiple types inside it

STOCK_PORTFOLIO

A portfolio that only invests in stock-related securities, such as stocks, ETFs, CFDs, ... It doesn't hold any FUNDs or Pension Plans

COMPOSITE_ASSETS_PORTFOLIO

A portfolio that only holds investments in Funds or Pension Plans

List portfolios for the given connection

get

Retrieve every portfolio for the given connection

Authorizations
Path parameters
tokenstringRequired

Token to identify the connection

Responses
200
Successfully retrieved all portfolios
application/json
401
Invalid credentials
application/json
404
Connection not found with the given token for the current app
application/json
500
Internal server error
application/json
get
GET /api/v1/queries/connections/{token}/portfolios HTTP/1.1
Host: api.finlink.vumi.io
Authorization: Bearer JWT
Accept: */*
[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "type": "STOCK_PORTFOLIO",
    "owners": [
      "CARLOS MATA GARCIA",
      "OSCAR MENDEZ VALLADARES"
    ],
    "balance": 1,
    "currency": "EUR",
    "createdAt": "2025-05-16T11:06:59.416Z",
    "updatedAt": "2025-05-16T11:06:59.416Z"
  }
]
  • GETList portfolios for the given connection
  • Portfolio types