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

# Lista leads



## OpenAPI

````yaml /openapi.yaml get /leads
openapi: 3.1.0
info:
  title: Metricaas API
  version: 1.0.0
  description: >
    API do Metricaas para automatizar o CRM de fora dele — registrar vendas de
    uma

    plataforma de pagamento, ler leads e conferir a atribuição de origem.


    **Base:** `https://app.metricaas.com.br/v1`


    Todo endpoint é server-to-server. Não há CORS: um token de API nunca deve ir

    para o navegador.
servers:
  - url: https://app.metricaas.com.br/v1
security:
  - bearerAuth: []
tags:
  - name: Sessão
  - name: Leads
  - name: Vendas
paths:
  /leads:
    get:
      tags:
        - Leads
      summary: Lista leads
      parameters:
        - name: stage
          in: query
          schema:
            type: string
          description: Nome da etapa do funil, ex. `Venda`.
        - name: origin
          in: query
          schema:
            type: string
            enum:
              - ctwa
              - link
              - organic
        - name: phone
          in: query
          schema:
            type: string
            example: '+5547984310462'
          description: >
            Acha o lead pelo telefone. Aceita qualquer formatação —

            `+5547984310462`, `554784310462` e `(47) 98431-0462` casam com o

            mesmo lead, porque a comparação é por **DDD + os 8 últimos dígitos**

            (o nono dígito entra e sai conforme o provedor).


            É o caminho para quem recebe um postback de pagamento: uma chamada
            em

            vez de paginar a base.
        - name: limit
          in: query
          schema:
            type: integer
            default: 50
            maximum: 200
        - name: cursor
          in: query
          schema:
            type: string
          description: >
            `next_cursor` da página anterior. A paginação é por cursor, não por

            `offset`: o worker escreve lead o tempo todo, e `offset` repetiria
            ou

            pularia linha no meio da varredura.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Lead'
                  next_cursor:
                    type: string
                    nullable: true
        '401':
          $ref: '#/components/responses/NaoAutenticado'
        '403':
          $ref: '#/components/responses/SemPermissao'
components:
  schemas:
    Lead:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
          nullable: true
        phone:
          type: string
          nullable: true
        origin:
          type: string
          enum:
            - ctwa
            - link
            - organic
        channel:
          type: string
          enum:
            - whatsapp
            - instagram
        stage:
          type: string
          nullable: true
        ad:
          type: object
          properties:
            campaign:
              type: string
              nullable: true
            adset:
              type: string
              nullable: true
            ad:
              type: string
              nullable: true
        sales:
          type: object
          properties:
            total:
              type: number
              description: Soma de todas as vendas do lead.
            count:
              type: integer
        created_at:
          type: string
          format: date-time
        stage_changed_at:
          type: string
          format: date-time
          nullable: true
    Problema:
      type: object
      description: Erros seguem RFC 7807.
      properties:
        type:
          type: string
        title:
          type: string
        status:
          type: integer
        detail:
          type: string
        errors:
          type: array
          items:
            type: object
            properties:
              field:
                type: string
              message:
                type: string
  responses:
    NaoAutenticado:
      description: Token ausente, inválido, expirado ou revogado
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problema'
    SemPermissao:
      description: O token não tem a capacidade exigida, ou é de leitura
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problema'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >
        `Authorization: Bearer mcp_…` — gere em **Configurações → Tokens de
        API**.


        O token tem modo `read` ou `write`. Um token `read` responde `403` a

        qualquer verbo que não seja `GET`. As capacidades do token são a

        **interseção** com as da pessoa que o emitiu: se ela perder acesso na

        grade de Equipe, o token perde junto, sem ninguém revogar nada.

````