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

# Listar clientes

> Lista todos os clientes cadastrados. A resposta inclui informações detalhadas de cada cliente, como dados pessoais, contato e endereço. Os resultados são paginados para melhor performance.



## OpenAPI

````yaml GET /customers
openapi: 3.1.0
info:
  title: OpenAPI Super APIs
  description: Documentação das APIs destinada a companhias da Super Pagamentos
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://sandbox-api.superpagamentos.com
    description: Ambiente de desenvolvimento
  - url: https://api.superpagamentos.com
    description: Ambiente de produção
security: []
paths:
  /customers:
    get:
      description: >-
        Lista todos os clientes cadastrados. A resposta inclui informações
        detalhadas de cada cliente, como dados pessoais, contato e endereço. Os
        resultados são paginados para melhor performance.
      parameters:
        - name: page
          in: query
          description: Número da página que deseja visualizar
          required: false
          schema:
            type: integer
            default: 1
            minimum: 1
        - name: limit
          in: query
          description: Quantidade de itens por página
          required: false
          schema:
            type: integer
            default: 10
            minimum: 1
            maximum: 100
      responses:
        '200':
          description: Listagem de clientes
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          format: uuid
                          example: 8a2edf48-704b-4c23-8278-a902e88a5f93
                        firstName:
                          type: string
                          example: João
                        lastName:
                          type: string
                          example: Silva
                        email:
                          type: string
                          example: email@email.com
                        phoneNumber:
                          type: string
                          example: '00000000000'
                        document:
                          type: string
                          example: '00000000000'
                        birthdate:
                          type: string
                          format: date
                          example: '1994-10-04'
                        address:
                          type: object
                          properties:
                            statusId:
                              type: string
                              example: APPROVED
                            zipcode:
                              type: integer
                              example: 87654321
                            street:
                              type: string
                              example: Rua B
                            streetNumber:
                              type: integer
                              example: 200
                            complement:
                              type: string
                              example: Casa 10
                            reference:
                              type: string
                              example: Ao lado da padaria
                            neighborhood:
                              type: string
                              example: Jardins
                            city:
                              type: string
                              example: São Paulo
                            state:
                              type: string
                              example: SP
                        statusId:
                          type: string
                          example: APPROVED
                        createdAt:
                          type: string
                          format: date-time
                          example: '2025-06-01T16:14:10.535Z'
                  meta:
                    type: object
                    properties:
                      total:
                        type: integer
                        example: 11
                      page:
                        type: integer
                        example: 1
                      limit:
                        type: integer
                        example: 10
                      totalPages:
                        type: integer
                        example: 2
                  message:
                    type: string
                    example: Listagem de clientes
        '400':
          description: Erro na requisição
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      message:
                        type: string
                        example: Erro ao listar clientes
                      returnCode:
                        type: integer
                        example: -7404
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Token JWT gerado na rota de autenticação (/auth). Deve ser enviado no
        formato: Bearer <token>

````