> ## Documentation Index
> Fetch the complete documentation index at: https://developer.pagou.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Listar clientes

> Liste perfis reutilizáveis de compradores.



## OpenAPI

````yaml api-reference/openapi-v2.json GET /v2/customers
openapi: 3.1.0
info:
  title: API PIX - v2
  description: API for Pagou.ai Gateway
  version: 2.0.0
  contact:
    name: Support
    url: https://pagou.ai
    email: support@pagou.ai
servers:
  - url: https://api.pagou.ai
    description: Production server
  - url: https://api.sandbox.pagou.ai
    description: Sandbox server for testing
security:
  - BearerAuth: []
  - ApiKeyAuth: []
  - BasicAuth: []
paths:
  /v2/customers:
    get:
      tags:
        - API - Customers
      summary: List Customers
      description: List all customers
      operationId: getCustomers
      parameters:
        - schema:
            default: 1
            type: number
            minimum: 1
          in: query
          name: page
          required: false
        - schema:
            default: 10
            type: number
            minimum: 1
            maximum: 100
          in: query
          name: limit
          required: false
        - schema:
            type: string
          in: query
          name: search
          required: false
          description: Free-text search across customer name, email and document.
        - schema:
            type: string
          in: query
          name: document_number
          required: false
          description: Filter by exact customer document number.
        - schema:
            type: string
          in: query
          name: email
          required: false
          description: Filter customers by exact email address.
        - schema:
            type: string
          in: query
          name: phone
          required: false
          description: Filter customers by phone number.
        - schema:
            type: string
          in: query
          name: external_ref
          required: false
          description: Filter customers by your external reference.
        - schema:
            type: string
          in: query
          name: status
          required: false
          description: Filter customers by current status.
        - schema:
            type: string
          in: query
          name: ip_address
          required: false
          description: Filter customers by last known IP address.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  requestId:
                    type: string
                  metadata:
                    type: object
                    properties:
                      page:
                        default: 1
                        type: number
                      limit:
                        default: 10
                        type: number
                      total:
                        default: 0
                        type: number
                    required:
                      - page
                      - limit
                      - total
                    additionalProperties: false
                  data:
                    type: array
                    items:
                      type: object
                      additionalProperties: {}
                required:
                  - success
                  - requestId
                  - metadata
                  - data
                additionalProperties: false
        '422':
          description: Validation error (RFC 7807)
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ValidationProblemDetails'
        default:
          description: RFC 7807 Problem Details error response
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      security:
        - BearerAuth: []
        - ApiKeyAuth: []
        - BasicAuth: []
components:
  schemas:
    ValidationProblemDetails:
      allOf:
        - $ref: '#/components/schemas/ProblemDetails'
        - type: object
          properties:
            errors:
              type: array
              items:
                type: object
                properties:
                  field:
                    type: string
                  message:
                    type: string
                  code:
                    type: string
                additionalProperties: true
          additionalProperties: true
    ProblemDetails:
      type: object
      description: RFC 7807 Problem Details object.
      properties:
        type:
          type: string
          format: uri-reference
        title:
          type: string
        status:
          type: number
        detail:
          type: string
        instance:
          type: string
          format: uri-reference
      required:
        - type
        - title
        - status
        - detail
      additionalProperties: true
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
    ApiKeyAuth:
      type: apiKey
      in: header
      name: apiKey
    BasicAuth:
      type: http
      scheme: basic
      description: Use Basic auth with username `token` and password `x`.

````