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. General API Resources
  2. Connections

List all connections

Last updated 11 months ago

This operation will return every connection status for those that had theirpublicTokens already exchanged. You can pass an externalId (more about it in ) as a parameter to get those connections associated to it.

Link parameters

List connections for the current app

get

Retrieve every connection status for the connections in the current app

Authorizations
Query parameters
externalIdstringOptional

The external ID of the connections you want to fetch

Responses
200
Successfully retrieved all connections
application/json
401
Invalid credentials
application/json
500
Internal server error
application/json
get
GET /api/v1/queries/connections HTTP/1.1
Host: api.finlink.vumi.io
Authorization: Bearer JWT
Accept: */*
[
  {
    "credentialsToken": "AAAAA11111",
    "status": "PENDING",
    "errorDetails": {
      "reason": "INTERNAL_SERVER_ERROR",
      "type": "VUMI_ERROR",
      "retryable": true
    },
    "entity": "santander",
    "createdAt": "2025-06-06T12:38:55.551Z",
    "updatedAt": "2025-06-06T12:38:55.551Z",
    "lastSync": "2025-06-06T12:38:55.551Z",
    "updateToken": "123e4567-e89b-12d3-a456-426614174000",
    "twoFactorEnabled": true,
    "hasCredentials": true,
    "externalId": "TEST"
  }
]