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

# List leads

> List leads for the team, with optional filters.



## OpenAPI

````yaml /openapi.json get /v1/leads
openapi: 3.0.0
info:
  title: Botdog API
  description: |-
    API documentation for Botdog.

    **Authentication**: Pass your API key as the `x-api-key` header.
    Example: `x-api-key: bd_live_abc123`

    Do NOT use the `Authorization` header.
  version: '1.0'
  contact: {}
servers:
  - url: https://api.botdog.co
    description: Production
security: []
tags:
  - name: campaigns
    description: >-
      Create, read, update, and control campaigns (pause/resume, pause
      activities, archive, delete).
  - name: leads
    description: >-
      List and filter leads, read full detail + event history, update metadata,
      add to a campaign, or stop a sequence.
  - name: lists
    description: Manage lead/audience lists and their members.
  - name: blacklist
    description: Manage suppression lists (excluded profiles).
  - name: snippets
    description: Manage message snippets / templates.
  - name: accounts
    description: >-
      Connected LinkedIn accounts (seats), their connection health, and daily
      sending limits.
  - name: webhooks
    description: Manage webhook subscriptions.
  - name: messaging
    description: >-
      Send messages and replies, schedule a future send, and mark conversations
      read/unread. Rate-limited per sending account.
  - name: analytics
    description: Team-level analytics totals, daily breakdowns, and per-user metrics.
  - name: users
    description: Read the users in your team.
  - name: teams
    description: Current team context.
  - name: health
    description: Service health checks (no authentication).
paths:
  /v1/leads:
    get:
      tags:
        - leads
      summary: List leads
      description: List leads for the team, with optional filters.
      operationId: LeadsController_findMany
      parameters:
        - name: campaignId
          required: false
          in: query
          description: Filter by campaign ID
          schema:
            type: string
        - name: listId
          required: false
          in: query
          description: Filter by list ID
          schema:
            type: string
        - name: campaignStatus
          required: false
          in: query
          description: Filter by status within the campaign
          schema:
            type: string
            enum:
              - CREATED
              - ACTIVE
              - PAUSED
              - ERROR
              - ARCHIVED
              - COMPLETED
        - name: replied
          required: false
          in: query
          description: Filter to leads that have / have not replied
          schema:
            type: boolean
        - name: unread
          required: false
          in: query
          description: Filter to leads with / without an unread reply
          schema:
            type: boolean
        - name: skipped
          required: false
          in: query
          description: Filter to leads that were / were not skipped
          schema:
            type: boolean
        - name: skippedReason
          required: false
          in: query
          description: Filter by skip reason
          schema:
            type: string
            enum:
              - DUPLICATE_IN_ANOTHER_CAMPAIGN_AT_IMPORT
              - DUPLICATE_IN_ANOTHER_TEAM_CAMPAIGN_AT_IMPORT
        - name: limit
          required: false
          in: query
          description: Maximum number of leads to return (1-100)
          schema:
            $ref: '#/components/schemas/Object'
        - name: cursor
          required: false
          in: query
          description: Cursor from a previous response, to fetch the next page
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedLeadsDto'
        '401':
          description: Unauthorized. API key is missing or invalid.
        '429':
          description: Rate limit exceeded. Retry after cooldown.
      security:
        - api-key: []
components:
  schemas:
    Object:
      type: object
      properties: {}
    PaginatedLeadsDto:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/LeadSummaryDto'
        nextCursor:
          type: string
          description: >-
            Opaque cursor for the next page; null when there are no more
            results. Pass it back as the `cursor` query parameter.
          nullable: true
      required:
        - data
        - nextCursor
    LeadSummaryDto:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier of the lead
        name:
          type: string
          description: The name of the lead
          example: Jane Doe
        linkedinProfile:
          type: string
          description: The LinkedIn profile URL of the lead
          example: https://www.linkedin.com/in/jane-doe
        company:
          type: string
          description: The lead's company
          nullable: true
        job:
          type: string
          description: The lead's job title
          nullable: true
        campaignId:
          type: string
          description: The campaign this lead belongs to, if any
          nullable: true
        listId:
          type: string
          description: The list this lead belongs to, if any
          nullable: true
        campaignStatus:
          type: string
          description: The lead's status within its campaign
          nullable: true
        hasReplied:
          type: boolean
          description: Whether the lead has replied
        hasUnreadReply:
          type: boolean
          description: Whether the lead has an unread reply
        isSkipped:
          type: boolean
          description: Whether the lead was skipped
        skippedReason:
          type: string
          description: Why the lead was skipped, if applicable
          nullable: true
        createdAt:
          format: date-time
          type: string
          description: When the lead was created
      required:
        - id
        - name
        - linkedinProfile
        - hasReplied
        - hasUnreadReply
        - isSkipped
        - createdAt
  securitySchemes:
    api-key:
      type: apiKey
      in: header
      name: x-api-key
      x-default: bd_live_your_key_here

````