> ## Documentation Index
> Fetch the complete documentation index at: https://fortal-pay.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Listar clientes

> Recupere a lista de clientes cadastrados na sua conta para consulta e gerenciamento.

## Exemplos de filtro

### Busca geral

Use `search` para procurar simultaneamente por nome, e-mail, documento ou telefone:

```bash theme={null}
curl --request GET 'https://api-sandbox.fortalpay.tech/v1/customers?search=Maria&page=0&size=20' \
  --header 'Authorization: ApiKey <api_key>'
```

O exemplo encontra clientes como `Maria Silva` e também registros cujo e-mail, documento ou telefone contenha o valor pesquisado.

### Filtros combinados

É possível combinar filtros específicos. Todos os parâmetros informados precisam corresponder ao cliente:

```bash theme={null}
curl --request GET 'https://api-sandbox.fortalpay.tech/v1/customers?name=Maria&email=example.com&document=529.982&status=ACTIVE&page=0&size=20' \
  --header 'Authorization: ApiKey <api_key>'
```

Documento e telefone podem ser enviados com ou sem formatação. Nome e e-mail não diferenciam maiúsculas de minúsculas.

### Exemplo em JavaScript

```javascript theme={null}
const params = new URLSearchParams({
  name: 'Maria',
  document: '529.982',
  status: 'ACTIVE',
  page: '0',
  size: '20'
});

const response = await fetch(`https://api-sandbox.fortalpay.tech/v1/customers?${params}`, {
  headers: {
    Authorization: `ApiKey ${process.env.FORTALPAY_API_KEY}`
  }
});

const result = await response.json();
```


## OpenAPI

````yaml openapi.yaml GET /customers
openapi: 3.1.0
info:
  title: FortalPay API
  version: '1'
  description: >
    API para gerenciar clientes, produtos e cupons e para criar ou listar
    cobranças.

    A autenticação utiliza uma API key no cabeçalho `Authorization`.
servers:
  - url: https://api-sandbox.fortalpay.tech/v1
    description: Produção — API v1
security:
  - apiKeyAuth: []
tags:
  - name: Clientes
    description: Crie, filtre, consulte e remova clientes do lojista associado à API key.
  - name: Charges
    description: >-
      Create Pix charges and list charges owned by the merchant associated with
      the API key.
  - name: Checkouts
    description: Crie páginas de pagamento hospedadas pela FortalPay usando uma API key.
  - name: Produtos
    description: >-
      Crie, liste, consulte, atualize e remova produtos do lojista associado à
      API key.
  - name: Coupons
    description: >-
      Create, list, retrieve, update, and delete coupons owned by the merchant
      associated with the API key.
paths:
  /customers:
    get:
      tags:
        - Clientes
      summary: Listar e filtrar clientes
      description: >-
        Retorna os clientes do lojista autenticado e permite filtrar por texto
        geral, nome, e-mail, documento, telefone ou situação. Os resultados são
        ordenados da criação mais recente para a mais antiga, e o tamanho
        efetivo da página é limitado a 100.
      operationId: listCustomers
      parameters:
        - $ref: '#/components/parameters/Page'
        - $ref: '#/components/parameters/Size'
        - $ref: '#/components/parameters/Sort'
        - name: search
          in: query
          required: false
          description: >-
            Busca parcial por nome, e-mail, documento e telefone, sem
            diferenciar maiúsculas de minúsculas. A formatação do documento e do
            telefone é ignorada.
          schema:
            type: string
          example: Maria
        - name: name
          in: query
          required: false
          description: Filtro parcial por nome, sem diferenciar maiúsculas de minúsculas.
          schema:
            type: string
          example: Maria Silva
        - name: email
          in: query
          required: false
          description: Filtro parcial por e-mail, sem diferenciar maiúsculas de minúsculas.
          schema:
            type: string
          example: maria@example.com
        - name: document
          in: query
          required: false
          description: >-
            Filtro parcial por CPF ou CNPJ. Os caracteres de formatação são
            ignorados.
          schema:
            type: string
          example: '529.982'
        - name: phone
          in: query
          required: false
          description: >-
            Filtro parcial por telefone. Os caracteres de formatação são
            ignorados.
          schema:
            type: string
          example: (85) 99999
        - name: status
          in: query
          required: false
          description: Filtro exato por situação, sem diferenciar maiúsculas de minúsculas.
          schema:
            $ref: '#/components/schemas/CustomerStatus'
          example: ACTIVE
      responses:
        '200':
          description: Página de clientes retornada com sucesso.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerPageEnvelope'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
components:
  parameters:
    Page:
      name: page
      in: query
      required: false
      description: Índice da página, começando em zero.
      schema:
        type: integer
        minimum: 0
        default: 0
    Size:
      name: size
      in: query
      required: false
      description: Quantidade de registros solicitada por página.
      schema:
        type: integer
        minimum: 1
        default: 20
    Sort:
      name: sort
      in: query
      required: false
      description: >-
        Expressão de ordenação do Spring Data. Cada serviço aplica a ordenação
        fixa documentada.
      schema:
        type: array
        items:
          type: string
      style: form
      explode: true
  schemas:
    CustomerStatus:
      type: string
      enum:
        - ACTIVE
    CustomerPageEnvelope:
      type: object
      required:
        - data
        - success
        - error
      properties:
        data:
          $ref: '#/components/schemas/CustomerPage'
        success:
          type: boolean
          const: true
        error:
          type: 'null'
    CustomerPage:
      allOf:
        - $ref: '#/components/schemas/PageMetadata'
        - type: object
          properties:
            content:
              type: array
              items:
                $ref: '#/components/schemas/Customer'
    ErrorEnvelope:
      type: object
      required:
        - data
        - success
        - error
      properties:
        data:
          type: 'null'
        success:
          type: boolean
          const: false
        error:
          $ref: '#/components/schemas/ApiError'
    PageMetadata:
      type: object
      properties:
        page:
          type: integer
        size:
          type: integer
        numberOfElements:
          type: integer
        totalElements:
          type: integer
        totalPages:
          type: integer
    Customer:
      type: object
      required:
        - id
        - name
        - status
        - created_at
        - updated_at
      properties:
        id:
          type: string
          format: uuid
          description: Identificador público do cliente.
        name:
          type: string
        email:
          type:
            - string
            - 'null'
        document:
          type:
            - string
            - 'null'
          description: CPF ou CNPJ mascarado, preservando somente os dois últimos dígitos.
          example: '***.***.***-25'
        phone:
          type:
            - string
            - 'null'
        status:
          $ref: '#/components/schemas/CustomerStatus'
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    ApiError:
      type: object
      required:
        - timestamp
        - status
        - message
        - path
      properties:
        timestamp:
          type: string
          format: date-time
        status:
          type: integer
        message:
          type: string
          description: Current backend messages are returned in Portuguese.
        path:
          type: string
        fields:
          type:
            - array
            - 'null'
          items:
            $ref: '#/components/schemas/FieldError'
    FieldError:
      type: object
      required:
        - field
        - message
      properties:
        field:
          type: string
        message:
          type: string
  responses:
    Unauthorized:
      description: >-
        A API key está ausente, malformada, não existe, foi revogada, expirou ou
        é incompatível com o ambiente do lojista.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    Forbidden:
      description: >-
        A API key foi autenticada, mas não possui permissão para acessar a rota
        solicitada.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: >
        Todas as requisições devem incluir sua API key no cabeçalho
        `Authorization`

        usando o formato `ApiKey <sua_api_key>`. Não use o esquema `Bearer`.

        Sem esse cabeçalho, a requisição será rejeitada.


        Use `fpay_sk_test_...` no ambiente de teste e `fpay_sk_live_...` em
        produção.

        [Saiba como criar e usar uma API key](/authentication).

````