Get Connection status

Get connection status

get

Retrieve the status of a given connection if it belongs to the current app

Authorizations

Path parameters

tokenstringRequired

Token to identify the connection

Responses

200

Successfully retrieved connection status

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

HTTPcURLJavaScriptPython

GET /api/v1/queries/connections/{token} 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-05-16T08:50:16.947Z",
  "updatedAt": "2025-05-16T08:50:16.947Z",
  "lastSync": "2025-05-16T08:50:16.947Z",
  "updateToken": "123e4567-e89b-12d3-a456-426614174000",
  "twoFactorEnabled": true,
  "hasCredentials": true,
  "externalId": "TEST"
}

Data Types

Connection Status

You can find four different statuses when retrieving a connection status:

Status	Description
PENDING	Connection is still importing data for the first time. This status rarely lasts for more than 5 minutes
READY	Last information extraction for the connection was correct. To know when it happenned, look at the lastSync field
UPDATING	Connection information is currently being updated. Typically related to manual updates.
ERRORED	Last information extraction encountered an error. To know more about it, look at errorDetails field.

Error reason

Found inside the errorDetails object, it indicates the reason for the error happenning

Error type