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

# Listar leads

> Lista leads com base nos parâmetros fornecidos.



## OpenAPI

````yaml https://api.meuassistente.rdstationmentoria.com.br/rest get /leads
openapi: 3.0.3
info:
  title: Agents
  version: 0.0.1
servers:
  - url: https://api.meuassistente.rdstationmentoria.com.br/rest
security: []
paths:
  /leads:
    get:
      tags:
        - Leads
      summary: Listar leads
      description: Lista leads com base nos parâmetros fornecidos.
      operationId: leads-list
      parameters:
        - name: page
          in: query
          required: false
          schema:
            type: number
            minimum: 1
            default: 1
          description: Número da página
        - name: size
          in: query
          required: false
          schema:
            type: number
            minimum: 1
            maximum: 100
            default: 20
          description: Tamanho da página
        - name: search
          in: query
          required: false
          schema:
            type: string
          description: Termo de pesquisa (full-text search)
        - name: name
          in: query
          required: false
          schema:
            type: string
          description: Nome
        - name: email
          in: query
          required: false
          schema:
            type: string
          description: Email
        - name: phone
          in: query
          required: false
          schema:
            type: string
          description: Telefone
        - name: orderBy
          in: query
          required: false
          schema:
            anyOf:
              - not: {}
              - type: string
                enum:
                  - createdAtDesc
                  - nameAsc
                description: Ordenação da lista de leads
            default: createdAtDesc
          description: Ordenação da lista de leads
        - name: createdAtStart
          in: query
          required: false
          schema:
            type: string
            format: date-time
          description: Data de criação
        - name: agentId
          in: query
          required: false
          schema:
            type: string
          description: Identificador do assistente
        - name: capture
          in: query
          required: false
          schema:
            type: string
            enum:
              - completed
              - partial
          description: Status da captura de dados do lead
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          description: Identificador do lead
                        agentId:
                          type: string
                          description: Assistente que capturou o lead
                          nullable: true
                          default: null
                        name:
                          type: string
                          nullable: true
                          default: null
                          description: Nome
                        email:
                          type: string
                          nullable: true
                          default: null
                          description: Email
                        phone:
                          type: string
                          nullable: true
                          default: null
                          description: Telefone
                        company:
                          type: string
                          nullable: true
                          default: null
                          description: Empresa
                        site:
                          type: string
                          nullable: true
                          default: null
                          description: Site
                        custom:
                          type: object
                          additionalProperties:
                            description: Valor do campo
                          default: {}
                          description: Campos
                        utm:
                          type: object
                          properties:
                            source:
                              type: string
                              nullable: true
                              description: Fonte (`utm_source`)
                            medium:
                              type: string
                              nullable: true
                              description: Meio (`utm_medium`)
                            campaign:
                              type: string
                              nullable: true
                              description: Campanha (`utm_campaign`)
                            content:
                              type: string
                              nullable: true
                              description: Conteúdo (`utm_content`)
                            term:
                              type: string
                              nullable: true
                              description: Termo (`utm_term`)
                          additionalProperties: false
                          description: Informações de rastreamento UTM
                          default: {}
                        capture:
                          type: string
                          enum:
                            - completed
                            - partial
                          description: Status da captura de dados do lead
                          default: completed
                        workspaceId:
                          type: string
                          description: Identificador do workspace associado
                        createdAt:
                          type: string
                          format: date-time
                          default: '2026-02-08T00:20:48.508Z'
                          description: Data de criação
                        updatedAt:
                          type: string
                          format: date-time
                          default: '2026-02-08T00:20:48.508Z'
                          description: Data da última atualização
                      required:
                        - id
                        - workspaceId
                      additionalProperties: false
                      description: Dados do lead
                    description: Lista de registros da página
                  meta:
                    type: object
                    properties:
                      total:
                        type: number
                        description: Total de registros
                      page:
                        type: number
                        description: Número da página atual
                      size:
                        type: number
                        description: Quantidade de registros da página
                      first:
                        type: number
                        description: Primeira página
                      last:
                        type: number
                        description: Última página
                      next:
                        type: number
                        nullable: true
                        description: Próxima página
                      previous:
                        type: number
                        nullable: true
                        description: Página anterior
                    required:
                      - total
                      - page
                      - size
                      - first
                      - last
                      - next
                      - previous
                    additionalProperties: false
                    description: Metadados da página
                required:
                  - data
                  - meta
                additionalProperties: false
                description: Página de registros
        default:
          $ref: '#/components/responses/error'
      security:
        - Authorization: []
components:
  responses:
    error:
      description: Error response
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
              code:
                type: string
              issues:
                type: array
                items:
                  type: object
                  properties:
                    message:
                      type: string
                  required:
                    - message
                  additionalProperties: false
            required:
              - message
              - code
            additionalProperties: false
  securitySchemes:
    Authorization:
      type: http
      scheme: bearer

````