List entities for app

This endpoint will return a list of the enabled entities for your current app.

List all app entities

Retrieve a list of all entities enabled for the current app

GEThttps://api.finlink.vumi.io/api/v1/queries/connected-entities

Authorization

bearerAuth

Response

200401500

Successfully retrieved entities list

Body

application/json

idstring

Unique identifier of the connected entity. Typically, it's the lowercase entity name

Example: "santander"

namestring

Readable name of the connected entity

Example: "Santander"

typeenum

Type of the connected entity. See Entities section for more information

Example: "BANK"

BROKERBANK

Request

JavaScriptCurlPython

const response = await fetch('https://api.finlink.vumi.io/api/v1/queries/connected-entities', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200

[
  {
    "id": "santander",
    "name": "Santander",
    "type": "BANK"
  }
]