v1

latestOpenAPI 3.1.0MIT2026-07-2484155300.5 KB

Connector

List

This endpoint retrieves all available connectors.

get/connectors

Query parameters

countriesstring[]

A list of countries of connectors to filter.

typesstring[]

A list of types of connectors to filter.

namestring

Name alike look up of the connector

sandboxboolean

Include sandbox connectors if set to true (default: false).

healthDetailsboolean

Include health details about latest connections and percentage of errors (connection rate)

isOpenFinanceboolean

Filter connectors by the isOpenFinance attribute. If not sent, it won't filter.

supportsPaymentInitiationboolean

Filter connectors by the supportsPaymentInitiation attribute. If not sent, it won't filter.

supportsSmartTransfersboolean

Filter connectors by the supportsSmartTransfers attribute. If not sent, it won't filter.

supportsAutomaticPixboolean

Filter connectors by the supportsAutomaticPix attribute. If not sent, it won't filter.

Response

Retrieve a list of all connectors

pagenumber double

totalnumber double

totalPagesnumber double

Example response

{
  "page": 1,
  "total": 1,
  "totalPages": 1,
  "results": [
    {
      "id": 601,
      "name": "Itaú",
      "primaryColor": "EC7000",
      "institutionUrl": "https://www.itau.com.br/assets/dam/publisher/07_itau_empresas/13_open_banking/logos_regulatorio_bacen/opb_log_reg_bac_itau_img_01.svg",
      "country": "BR",
      "type": "PERSONAL_BANK",
      "credentials": [
        {
          "validation": "^\\d{3}\\.?\\d{3}\\.?\\d{3}-?\\d{2}$",
          "validationMessage": "CPF deve ter 11 números.",
          "label": "CPF",
          "name": "cpf",
          "type": "number",
          "placeholder": "",
          "optional": false
        }
      ],
      "imageUrl": "https://cdn.pluggy.ai/assets/connector-icons/201.svg",
      "hasMFA": false,
      "oauth": true,
      "health": {
        "status": "ONLINE",
        "stage": null
      },
      "products": [
        "ACCOUNTS",
        "TRANSACTIONS",
        "IDENTITY",
        "CREDIT_CARDS",
        "PAYMENT_DATA",
        "LOANS",
        "INVESTMENTS"
      ],
      "createdAt": "2023-09-01T18:05:09.145Z",
      "isSandbox": false,
      "isOpenFinance": true,
      "updatedAt": "2024-07-16T15:34:08.028Z",
      "supportsPaymentInitiation": true,
      "supportsScheduledPayments": true,
      "supportsSmartTransfers": true,
      "supportsBoletoManagement": true
    }
  ]
}