---
title: "List"
method: GET
path: "/payments/customers"
tags: ["Payment Customer"]
---

# List

`GET /payments/customers`

Recovers all created payment customers

## Query parameters

- `pageSize` number, double
- `page` number, double
- `name` string
- `email` string
- `cpf` string
- `cnpj` string

## Response `200`

Retrieve a list of all payment customers

- object
  - `page` number, double
  - `total` number, double
  - `totalPages` number, double
  - `results` PaymentCustomer[] — List of payment customers
    - `id` string, required — Primary identifier
    - `type` 'INDIVIDUAL' | 'BUSINESS', required — Customer type. - `INDIVIDUAL`: identified by `cpf`. - `BUSINESS`: identified by `cnpj`.
    - `name` string, required — Customer name
    - `email` string — Customer email
    - `cpf` string — Customer CPF
    - `cnpj` string — Customer CNPJ, if type is `BUSINESS`
    - `connector` Connector — Connector object
      - `id` number, required — Primary identifier
      - `name` string — Name of the institution
      - `institutionUrl` string — Homepage of the institution
      - `imageUrl` string — Image of the logo hosted by Pluggy
      - `primaryColor` string — Primary color
      - `type` string — Type of institution
      - `country` string — Country located
      - `credentials` ConnectorCredential[] — Parameters required to start the connection
        - `name` string, required — Name of the key
        - `label` string, required — Label for input
        - `type` 'text' | 'password' | 'number' | 'image' | 'select', required — Type of credential required
        - `assistiveText` string — Text to help the user when completing the input
        - `data` string — Used to return base64 images
        - `placeholder` string — Placeholder text for the input
        - `validation` string — Regex validation for the user's input
        - `validationMessage` string — Validation message when input doesn't match the regex
        - `mfa` boolean — Credential is an MFA parameter and must be refreshed on each execution
        - `options` CredentialSelectOption[] — List of possible values for the input
          - `value` string, required — Value for the option
          - `label` string, required — Label for the option
      - `hasMFA` boolean — Does the connector require an MFA to execute?
      - `products` string[] — Products supported by the connector
      - `oauth` boolean — If 'true', the connector requires an Oauth flow to execute
      - `oauthUrl` string — URL to perform Oauth flow if needed
      - `resetPasswordUrl` string — URL to the financial institution to reset the password
      - `health` ConnectorHealth — Connector health status
        - `status` string — 'ONLINE' | 'OFFLINE' | 'UNSTABLE'
        - `stage` string
        - `details` object — Statistics about your recent connections on the connector and recent connection rate (percentage of healthy connections). This field is only present if you include the parameter healthDetails=true. This will be null if there was an error obtaining health details.
          - `connectionRateLast6Hours` number — A number from 0 to 100: the percentage of executions that succesfully connect to the institution: status of CONNECTION_ERROR,ERROR,SITE_NOT_AVAILABLE decrease the percentage. Any other status (like SUCCESS/LOGIN_ERROR) increase the percentage. The value will be null if there were no connections
          - `connectionsLast6Hours` number — Amount of your connections for this connector during the last 6 hours. 0 if there were no connections
      - `isOpenFinance` boolean — Indicates if the connector uses the regulated Open Finance APIs
      - `supportsPaymentInitiation` boolean — Indicates if the connector supports the payment initiation API
      - `supportsScheduledPayments` boolean — Indicates if the connector supports scheduled payments
      - `supportsSmartTransfers` boolean — Indicates if the connector supports smart transfers
      - `supportsBoletoManagement` boolean — Indicates if the connector supports boleto management
      - `supportsAutomaticPix` boolean — Indicates if the connector supports automatic Pix
      - `createdAt` string, date-time — Date of creation
      - `updatedAt` string, date-time — Date of last modification
    - `createdAt` string, date-time, required — Date when the customer was created
    - `updatedAt` string, date-time, required — Date when the customer was last updated

---

[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)