Get Connection status

Get connection status

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

get

/api/v1/queries/connections/{token}

Authorizations

Path parameters

tokenstringrequired

Token to identify the connection

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.finlink.vumi.io/api/v1/queries/connections/{token}' \
  --header 'Authorization: Bearer JWT'

200

401

404

500

200

{
  "credentialsToken": "AAAAA11111",
  "status": "PENDING",
  "errorDetails": {
    "reason": "INTERNAL_SERVER_ERROR",
    "type": "VUMI_ERROR",
    "retryable": true
  },
  "entity": "santander",
  "createdAt": "2025-03-12T04:20:26.851Z",
  "updatedAt": "2025-03-12T04:20:26.851Z",
  "lastSync": "2025-03-12T04:20:26.851Z",
  "updateToken": "123e4567-e89b-12d3-a456-426614174000",
  "twoFactorEnabled": true,
  "hasCredentials": true,
  "externalId": "TEST"
}

Successfully retrieved connection status

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