> ## Documentation Index
> Fetch the complete documentation index at: https://docs.goatpay.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Listar clientes

> Lista clientes de cobrança da conta.

<RequestExample>
  ```bash cURL theme={null}
  curl -X GET 'https://api.goatpay.com.br/v1/customers/list' \
    -H 'X-API-Key: gp_live_SUA_CHAVE'
  ```
</RequestExample>

<ResponseExample>
  ```json Success theme={null}
  {
    "success": true,
    "message": "Clientes listados",
    "data": {
      "items": [{
      "id": "clx_customer",
      "name": "Cliente Exemplo",
      "email": "cliente@email.com",
      "whatsapp": "11999999999",
      "phone": "11999999999",
      "document": "123.456.789-09",
      "city": "São Paulo",
      "state": "SP",
      "type": "PF",
      "status": "Ativo",
      "createdAt": "2026-07-01T12:00:00.000Z",
      "lastActivityAt": "2026-07-04T10:00:00.000Z",
      "transactions": 5,
      "volume": 499.5
    }],
      "page": 1,
      "pageSize": 50,
      "total": 1,
      "pages": 1,
      "summary": {
        "totalCustomers": 1,
        "activeCustomers": 1,
        "totalTransactions": 5,
        "totalVolume": 499.5
      }
    },
    "requestId": "req_abc"
  }
  ```
</ResponseExample>


## OpenAPI

````yaml GET /customers/list
openapi: 3.1.0
info:
  title: GoatPay API
  description: >
    API pública merchant da GoatPay. Autenticação via header `X-API-Key:
    gp_live_...`.

    Respostas de sucesso usam o envelope `{ success, message, data, requestId
    }`.

    Campos internos (`accountId`, `metadata`, histórico de entregas de webhook,
    etc.) não são expostos.

    `providerTransactionId` aparece como `referenceId`; `providerInfractionId`
    como `infractionId`.

    Rate limit global: 100 requisições por minuto por API key (HTTP 429). Sem
    chave, limite por IP.
  version: 1.0.0
servers:
  - url: https://api.goatpay.com.br/v1
    description: Produção
security:
  - apiKeyAuth: []
tags:
  - name: pix
    description: >-
      Cobranças PIX (receber), reembolsos de depósito recebido e transferências
      PIX (enviar). Alias legado em payouts/* para envios.
  - name: transfer-internal
    description: Transferências entre contas GoatPay
  - name: transfer-scheduled
    description: Transferências programadas (agendar, repetir ou por saldo)
  - name: crypto
    description: Depósitos e transferências em criptomoeda
  - name: billings
    description: >-
      Cobranças avulsas (pagamento único) — boleto, cartão ou PIX na Conta
      Padrão (PF ou PJ)
  - name: subscriptions
    description: >-
      Assinaturas recorrentes com ciclo fixo — boleto, cartão ou PIX na Conta
      Padrão (PF ou PJ)
  - name: account
    description: Saldo e extrato
  - name: subaccount
    description: Subcontas merchant (carteiras lógicas sob a conta principal)
  - name: meds
    description: Disputas MED
  - name: webhooks
    description: Endpoints de webhook de saída
  - name: payouts
    description: Alias de transfer-pix para saques PIX
  - name: customers
    description: Clientes da loja (CRM)
  - name: products
    description: Produtos e entregas digitais
  - name: coupons
    description: Cupons de desconto para links
  - name: payment-links
    description: Links de pagamento e checkout hospedado
paths:
  /customers/list:
    get:
      tags:
        - customers
      summary: Listar clientes
      description: Paginação e busca por nome, e-mail ou documento.
      operationId: listStoreCustomers
      parameters:
        - $ref: '#/components/parameters/ListPage'
        - $ref: '#/components/parameters/ListPageSize'
        - name: search
          in: query
          schema:
            type: string
            maxLength: 120
        - name: status
          in: query
          schema:
            type: string
            description: Ativo, Inativo, Bloqueado ou active/inactive/blocked
      responses:
        '200':
          $ref: '#/components/responses/StoreListSuccess'
components:
  parameters:
    ListPage:
      name: page
      in: query
      schema:
        type: integer
        minimum: 1
        default: 1
    ListPageSize:
      name: pageSize
      in: query
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 50
  responses:
    StoreListSuccess:
      description: Lista paginada (clientes, produtos, cupons ou links).
      content:
        application/json:
          schema:
            type: object
            required:
              - success
              - message
              - data
            properties:
              success:
                type: boolean
              message:
                type: string
              data:
                $ref: '#/components/schemas/PublicPagedStoreList'
              requestId:
                type: string
  schemas:
    PublicPagedStoreList:
      type: object
      properties:
        items:
          type: array
          items:
            type: object
        page:
          type: integer
        pageSize:
          type: integer
        total:
          type: integer
        pages:
          type: integer
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: Chave `gp_live_...` criada em Integrações → Chaves de API no dashboard.

````