---
title: "Get a connection"
method: GET
path: "/connections/{id}"
tags: ["Connections"]
---

# Get a connection

`GET /connections/{id}`

> ⚠️
>
> **Authentication**
> This endpoint requires [app-scoped](/reference/api-akahu-io-authentication#app-scoped-endpoints) authentication.

Get an individual financial institution connection.

- [📚 Supported Integrations List](/docs/integrations#supported-integrations)

## Response `200`

Successful response.

- object
  - `success` boolean
  - `item` Connection
    - `_id` string, cuid, required — The connected financial institution's unique identifier. This will always be prefixed with `conn_`.
    - `_classic` string, cuid — The ID of the corresponding classic connection for this institution. This is only present for official open banking connections (Read more [here](/docs/official-open-banking)).
    - `name` string, required — Display name for the connected institution.
    - `logo` string, uri, required — A URL pointing to an image of the institution's logo.
    - `connection_type` 'classic' | 'official', required — The type of integration used to connect to this institution. This will be one of: - `classic` A classic Akahu connection, which uses Akahu's custom built integration to connect to the institution. - `official` An official open banking connection, which uses the institution's official open banking APIs.
    - `new_connections_enabled` boolean, required — Whether new connections to this institution are allowed. This may be `false` if your app is configured to migrate users to the official open banking connection for this provider.
    - `mode` 'strict' | 'migration' | 'side_by_side' | 'developer' — The migration mode of this connection. This is only present for official open banking connections (Read more [here](/docs/official-open-banking)). The `mode` will be one of: - `strict` The classic equivalent of this connection is not available to your users. This mode can only be configured for new apps or apps that have successfully migrated all users away from their existing classic connections for this provider. - `migration` Any existing classic connections to this provider will continue to operate, but users will be unable to set up a new classic connection for this provider. New connections can only be established using this official open banking connection. - `side_by_side` Your users will be able to choose when setting up a new connection whether they wish to use the classic or official open banking connection for this provider. This mode is useful for apps that want to enable an official open banking connection where possible, but provide a fallback for users with account types that are not yet supported by the official open banking connection. - `developer` This is like migration mode, but will allow developers to continue to connect classic connections, so that they can test the migration process. This mode can only be enabled in non-production environments.
    - `deadline` string — The deadline date for users to migrate from classic to official open banking connections. This is only present for official open banking connections in `migration` or `developer` mode (Read more [here](/docs/official-open-banking)).

## Other responses

- `400` — Your request was malformed or otherwise unacceptable. More details are provided under the `message` key in the response.
- `401` — You are not authorised to access this content.
- `403` — You are not allowed to access this content.
- `404` — The item you are trying to access doesn't exist.
- `500` — An internal error has prevented us from processing the request. More detail may be supplied in the `message` key.

---

[API](https://skmtc.dev/akahu/apis/akahu-enduring-api.md) · [All operations](https://skmtc.dev/akahu/apis/akahu-enduring-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/akahu/akahu-enduring-api/revisions/b2de9915920d/schema)