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

# Listar clientes

> Retorna uma lista de todos os clientes com filtro opcional por projeto.



## OpenAPI

````yaml GET /api/v1/customers/
openapi: 3.0.3
info:
  title: Bob Payments API
  description: >-
    API de pagamentos Bob Payments para criar, acompanhar e conciliar transações
    com PIX e cartão de crédito.
  version: 1.0.0
servers:
  - url: https://api.payments.bob.company
    description: Servidor de produção
security: []
paths:
  /api/v1/customers/:
    get:
      summary: Listar todos os clientes
      description: Retorna uma lista de todos os clientes com filtro opcional por projeto.
      parameters:
        - schema:
            default: 1
            type: integer
            exclusiveMinimum: true
            maximum: 9007199254740991
          in: query
          name: page
          required: false
        - schema:
            default: 10
            type: integer
            exclusiveMinimum: true
            maximum: 100
          in: query
          name: limit
          required: false
        - schema: {}
          in: query
          name: dateFrom
          required: false
        - schema: {}
          in: query
          name: dateTo
          required: false
        - schema:
            type: string
            minLength: 1
            maxLength: 200
          in: query
          name: search
          required: false
        - schema:
            type: string
            minLength: 1
            maxLength: 20
          in: query
          name: document
          required: false
        - schema:
            type: string
            minLength: 1
            maxLength: 20
          in: query
          name: phone
          required: false
        - schema:
            type: string
            maxLength: 200
            format: email
            pattern: >-
              ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
          in: query
          name: email
          required: false
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        projectId:
                          type: string
                        name:
                          type: string
                        document:
                          type: string
                        email:
                          type: string
                        phone:
                          type: string
                        street:
                          type: string
                        streetNumber:
                          type: string
                        neighborhood:
                          type: string
                        complement:
                          nullable: true
                          type: string
                        zipCode:
                          type: string
                        city:
                          type: string
                        state:
                          type: string
                        country:
                          type: string
                        isBlocked:
                          type: boolean
                        blockedAt:
                          nullable: true
                          type: string
                        blockedReason:
                          nullable: true
                          type: string
                        blockExpiresAt:
                          nullable: true
                          type: string
                        blockType:
                          nullable: true
                          type: string
                        createdAt:
                          type: string
                        updatedAt:
                          type: string
                      required:
                        - id
                        - projectId
                        - name
                        - document
                        - email
                        - phone
                        - street
                        - streetNumber
                        - neighborhood
                        - complement
                        - zipCode
                        - city
                        - state
                        - country
                        - isBlocked
                        - blockedAt
                        - blockedReason
                        - blockExpiresAt
                        - blockType
                        - createdAt
                        - updatedAt
                      additionalProperties: false
                  meta:
                    type: object
                    properties:
                      total:
                        type: integer
                        minimum: -9007199254740991
                        maximum: 9007199254740991
                      page:
                        type: integer
                        minimum: -9007199254740991
                        maximum: 9007199254740991
                      limit:
                        type: integer
                        minimum: -9007199254740991
                        maximum: 9007199254740991
                      totalPages:
                        type: integer
                        minimum: -9007199254740991
                        maximum: 9007199254740991
                    required:
                      - total
                      - page
                      - limit
                      - totalPages
                    additionalProperties: false
                required:
                  - success
                  - data
                  - meta
                additionalProperties: false
        '400':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  type:
                    type: string
                  title:
                    type: string
                  status:
                    type: integer
                    minimum: 400
                    maximum: 599
                  detail:
                    type: string
                  instance:
                    type: string
                  details:
                    type: object
                    additionalProperties: {}
                required:
                  - type
                  - title
                  - status
                  - detail
                  - instance
                additionalProperties: false
        '404':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  type:
                    type: string
                  title:
                    type: string
                  status:
                    type: integer
                    minimum: 400
                    maximum: 599
                  detail:
                    type: string
                  instance:
                    type: string
                  details:
                    type: object
                    additionalProperties: {}
                required:
                  - type
                  - title
                  - status
                  - detail
                  - instance
                additionalProperties: false
        '429':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  type:
                    type: string
                  title:
                    type: string
                  status:
                    type: integer
                    minimum: 400
                    maximum: 599
                  detail:
                    type: string
                  instance:
                    type: string
                  details:
                    type: object
                    additionalProperties: {}
                required:
                  - type
                  - title
                  - status
                  - detail
                  - instance
                additionalProperties: false
        '500':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  type:
                    type: string
                  title:
                    type: string
                  status:
                    type: integer
                    minimum: 400
                    maximum: 599
                  detail:
                    type: string
                  instance:
                    type: string
                  details:
                    type: object
                    additionalProperties: {}
                required:
                  - type
                  - title
                  - status
                  - detail
                  - instance
                additionalProperties: false
      security:
        - ApiKeyAuth: []
        - BearerAuth: []
components:
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: >-
        Autenticação por API Key usando token SK (sk_live_xxx ou sk_test_xxx).
        Envie como: Authorization: Bearer sk_live_xxx
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Token JWT para endpoints autenticados do dashboard

````