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

# Listar clientes

> Retorna todos os clientes vinculados ao parceiro com filtros opcionais.



## OpenAPI

````yaml GET /v1/customer/list
openapi: 3.0.1
info:
  title: WebIntegration
  description: Este documento descreve os endpoints disponíveis da API.
  version: '1.0'
servers:
  - url: https://api.staging.cartaosimples.com.br/integration
    description: Servidor para o ambiente de staging
security:
  - bearerAuth: []
paths:
  /v1/customer/list:
    get:
      tags:
        - Cliente
      summary: Listar clientes.
      description: Retorna todos os clientes vinculados ao parceiro com filtros opcionais.
      operationId: listCustomers
      parameters:
        - name: nome
          in: query
          description: Filtrar por nome do cliente. Campo opcional.
          schema:
            type: string
            example: Maria Souza
          example: Maria Souza
        - name: documento
          in: query
          description: Filtrar por CPF do cliente (somente números). Campo opcional.
          schema:
            type: string
            example: '12345678901'
          example: '12345678901'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: >-
                    #/components/schemas/Integration.Shared.Responses.Customer.CustomerIntegrationResponse
              example:
                - id: 9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d
                  nome: Maria Souza
                  documento: '98765432100'
                  endereco:
                    rua: Av. Paulista
                    cidade: São Paulo
                    estado: SP
                    bairro: Bela Vista
                    cep: 01310-100
                    pais: BR
                    numero: '1578'
                    complemento: Apto 42
                  dataDeNascimento: '1990-03-22T00:00:00Z'
                  email: maria.souza@email.com
                  celular: +55 (11) 91234-5678
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
        '500':
          description: Internal Server Error
components:
  schemas:
    Integration.Shared.Responses.Customer.CustomerIntegrationResponse:
      type: object
      properties:
        id:
          type: string
          format: uuid
        nome:
          type: string
        documento:
          type: string
        endereco:
          $ref: '#/components/schemas/Integration.Shared.Responses.Customer.Address'
        dataDeNascimento:
          type: string
          format: date-time
        email:
          type: string
          nullable: true
        celular:
          type: string
          nullable: true
      additionalProperties: false
    Microsoft.AspNetCore.Mvc.ProblemDetails:
      type: object
      properties:
        tipo:
          type: string
          nullable: true
        titulo:
          type: string
          nullable: true
        status:
          type: integer
          format: int32
          nullable: true
        detalhe:
          type: string
          nullable: true
        instancia:
          type: string
          nullable: true
      example:
        tipo: https://tools.ietf.org/html/rfc7231#section-6.5.1
        titulo: Requisição inválida.
        status: 400
        detalhe: O campo 'cpf' é obrigatório.
        instancia: /v1/order
    Integration.Shared.Responses.Customer.Address:
      type: object
      properties:
        rua:
          type: string
          nullable: true
        cidade:
          type: string
          nullable: true
        estado:
          type: string
          nullable: true
        bairro:
          type: string
          nullable: true
        cep:
          type: string
          nullable: true
        pais:
          type: string
          nullable: true
        numero:
          type: string
          nullable: true
        complemento:
          type: string
          nullable: true
      additionalProperties: false
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Cabeçalho de autenticação Bearer no formato `Bearer <token>` onde
        `<token>` é seu TOKEN de autenticação

````