v1

latestOpenAPI 3.1.02026-07-2483219318.4 KB

Connections

Get all connections

⚠️

Authentication This endpoint requires app-scoped authentication.

Gets a list of all connected financial institutions that users can connect to your Akahu application.

📚 Supported Integrations List

get/connections

Response

Successful response.

successboolean

Example response

{
  "success": true,
  "items": [
    {
      "_id": "conn_cjgaaqcna000001ldwof8tvj0",
      "name": "ASB",
      "logo": "https://cdn.akahu.nz/logos/connections/conn_cjgaaqcna000001ldwof8tvj0",
      "connection_type": "classic",
      "new_connections_enabled": false
    },
    {
      "_id": "conn_cm4hlog270000914n33hj6tqq",
      "_classic": "conn_cjgaaqcna000001ldwof8tvj0",
      "name": "ASB",
      "logo": "https://cdn.akahu.nz/logos/connections/conn_cm4hlog270000914n33hj6tqq",
      "connection_type": "official",
      "new_connections_enabled": true,
      "mode": "migration",
      "deadline": "2025-12-31"
    }
  ]
}