---
title: "List"
method: GET
path: "/accounts"
tags: ["Account"]
---

# List

`GET /accounts`

Recovers all accounts collected for the item provided

## Query parameters

- `itemId` string, uuid, required
- `type` 'BANK' | 'CREDIT'

## Response `200`

Retrieve a list of all accounts

- object
  - `page` number, double
  - `total` number, double
  - `totalPages` number, double
  - `results` Account[] — List of retrieved accounts
    - `id` string, required — Primary account identifier
    - `type` 'BANK' | 'CREDIT', required — Top-level account category. - `BANK`: deposit accounts (checking, savings). The `bankData` object is populated. - `CREDIT`: credit-card accounts. The `creditData` object is populated.
    - `subtype` 'SAVINGS_ACCOUNT' | 'CHECKING_ACCOUNT' | 'CREDIT_CARD', required — Account subtype within its `type`. - `CHECKING_ACCOUNT`: conta corrente (`type=BANK`). - `SAVINGS_ACCOUNT`: conta poupança (`type=BANK`). - `CREDIT_CARD`: credit card account (`type=CREDIT`). For these the `number` field is masked to the last 4 digits.
    - `number` string, required — External identifier of the account
    - `name` string, required — Name of the account in a descriptive format
    - `marketingName` string — Name of the account as defined externally
    - `balance` number, double, required — Funds of the account
    - `itemId` string, uuid, required — Attached item's primary identifier
    - `taxNumber` string — Tax ID of the corresponding owner
    - `owner` string — Name of the owner of the account
    - `currencyCode` string, required — Code referencing the currency of the balance
    - `bankData` BankData — Bank account additional fields
      - `transferNumber` string — Complete number of the bank account `(agency code / account number)`
      - `closingBalance` number, double — Balance including not posted transactions
      - `automaticallyInvestedBalance` number, double — Balance automatically invested in the account by the FI
      - `overdraftContractedLimit` number, double — Overdraft contracted limit
      - `overdraftUsedLimit` number, double — Overdraft used limit
      - `unarrangedOverdraftAmount` number, double — Valor de operação contratada em caráter emergencial para cobertura de saldo devedor em conta de depósitos à vista e de excesso sobre o limite pactuado de cheque especial.
      - `hasReservedBalance` boolean, nullable — Whether the account has any active reserved balances ("saldo reservado"), such as goal-based savings ("caixinhas") or judicial holds
      - `reservedBalances` ReservedBalance[], nullable — Funds reserved/earmarked on the account. Only present when hasReservedBalance is true and the institution exposes the data
        - `name` string — User-given name for the reservation (for example, 'Caixinha Para Férias')
        - `identification` string, required — Unique identifier of the reservation
        - `availableAmounts` ReservedBalanceAmount[], required — Available amount(s) in the reservation, one entry per remuneration band
          - `amount` number, double, required — Reserved amount
          - `currencyCode` string, required — Amount currency code (for example, BRL)
          - `remuneration` ReservedBalanceRemuneration — Remuneration applied to a reserved balance
            - `preFixedRate` number, double — Pre-fixed remuneration rate, as a fraction (for example, 0.3 = 30%)
            - `postFixedIndexerPercentage` number, double — Post-fixed indexer percentage, as a fraction (for example, 1.1 = 110% of the indexer)
            - `rateType` string — Rate type (LINEAR or EXPONENCIAL)
            - `indexer` string — Indexer used as remuneration reference (for example, CDI, IPCA, SELIC)
            - `calculation` string — Calculation basis (DIAS_UTEIS or DIAS_CORRIDOS)
            - `ratePeriodicity` string — Rate periodicity (MENSAL, ANUAL, DIARIO or SEMESTRAL)
            - `indexerAdditionalInfo` string — Additional indexer info, required when indexer is OUTROS
    - `creditData` CreditData — Credit account additional fields
      - `level` string — Card level (Black, Signature)
      - `brand` string — Card Brand (Visa, Mastercard, Elo)
      - `brandAdditionalInfo` string — Free text describing the brand category when brand is 'OTHER'
      - `balanceCloseDate` string, date-time — Date when the balance was closed
      - `balanceDueDate` string, date-time — Date when the balance is dued
      - `availableCreditLimit` number, double — Credit limit available to spent
      - `balanceForeignCurrency` number, double — Balance in USD
      - `minimumPayment` number, double — Minimum payment due
      - `creditLimit` number, double — Maximum amount that can be spent
      - `isLimitFlexible` boolean — Indicates whether the credit limit can be adjusted (e.g. a customer can request an increase). Only returned when reported by the institution.
      - `status` 'ACTIVE' | 'BLOCKED' | 'CANCELLED' — Credit card status
      - `holderType` 'MAIN' | 'ADDITIONAL' — Credit card holder type
      - `disaggregatedCreditLimits` DisaggregatedCreditLimit[] — Disaggregated credit card limits
        - `creditLineLimitType` string, required — Limit type (LIMITE_CREDITO_TOTAL or LIMITE_CREDITO_MODALIDADE_OPERACAO)
        - `consolidationType` string, required — Indicates if the limit is consolidated or individual
        - `identificationNumber` string, required — Identification number of the additional credit card
        - `isLimitFlexible` boolean, required — Indicates if the limit is flexible
        - `usedAmount` number, double, required — Used amount of the additional credit card
        - `usedAmountCurrencyCode` string, required — Used amount currency code (for example, BRL)
        - `lineName` 'CREDITO_A_VISTA' | 'CREDITO_PARCELADO' | 'SAQUE_CREDITO_BRASIL' | 'SAQUE_CREDITO_EXTERIOR' | 'EMPRESTIMO_CARTAO_CONSIGNADO' | 'OUTROS' — Name of the credit limit line
        - `lineNameAdditionalInfo` string — Free text describing the line name when lineName is 'OUTROS'
        - `limitAmount` number, double — Limit amount of the additional credit card
        - `limitAmountCurrencyCode` string — Limit amount currency code (for example, BRL)
        - `limitAmountReason` string — Reason why the reported total limit amount is equal to zero
        - `customizedLimitAmount` number, double — Total limit amount customized by the customer through the institution's electronic channels
        - `customizedLimitAmountCurrencyCode` string — Customized limit amount currency code (for example, BRL)
        - `availableAmount` number, double — Available amount of the additional credit card
        - `availableAmountCurrencyCode` string — Available amount currency code (for example, BRL)
      - `additionalCards` AdditionalCard[] — Additional credit cards associated with the main one
        - `number` string, required — Number of the additional credit card
    - `createdAt` string, date-time, required — Date when the account was first created in Pluggy
    - `updatedAt` string, date-time, required — Date of the last update of the account data

---

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