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

# List leads

> List and filter the workspace's leads. Also returns the declared custom columns, the past lead searches that produced these leads, the workspace total and the plan's lead limit — everything a grid needs in one call.

Requires the `read` permission.



## OpenAPI

````yaml GET /api/leads
openapi: 3.1.0
info:
  title: ManyPI API
  description: >-
    The REST API behind ManyPI — AI lead generation, email validation,
    cold-email outreach, agent runs and web scraping. Every endpoint is
    authenticated with a ManyPI API key (`mpi_...`) or an OAuth 2.1 access
    token, and honours the permissions granted to that credential.
  version: 2.0.0
  contact:
    name: ManyPI Support
    email: support@manypi.com
    url: https://manypi.com
servers:
  - url: https://app.manypi.com
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Leads
    description: Find, store, enrich and manage leads.
  - name: Email validation
    description: Verify that lead addresses can receive mail.
  - name: Outreach
    description: Inboxes, sequences, campaigns, sending and replies.
  - name: Agent
    description: Agent runs, replies and skills.
  - name: Scraping
    description: Scrapers, runs and extracted data.
  - name: Endpoints
    description: Publish scrapers as typed REST endpoints.
  - name: Account
    description: Key validation and account information.
paths:
  /api/leads:
    get:
      tags:
        - Leads
      summary: List leads
      description: >-
        List and filter the workspace's leads. Also returns the declared custom
        columns, the past lead searches that produced these leads, the workspace
        total and the plan's lead limit — everything a grid needs in one call.


        Requires the `read` permission.
      operationId: listLeads
      parameters:
        - name: q
          in: query
          description: Free text across company, full name, email and domain.
          schema:
            type: string
        - name: status
          in: query
          description: >-
            A lead status, or `archived` / `unsubscribed` (which are flags, not
            statuses).
          schema:
            type: string
            enum:
              - new
              - qualified
              - contacted
              - disqualified
              - archived
              - unsubscribed
        - name: campaign
          in: query
          description: The agent run id of the lead search that produced the leads.
          schema:
            type: string
            format: uuid
        - name: brand
          in: query
          description: Narrow to one brand, or `all` for the whole workspace.
          schema:
            type: string
        - name: limit
          in: query
          description: Max 500.
          schema:
            type: integer
            default: 100
            maximum: 500
        - name: offset
          in: query
          schema:
            type: integer
            default: 0
      responses:
        '200':
          description: Leads and grid metadata.
          content:
            application/json:
              schema:
                type: object
                properties:
                  leads:
                    type: array
                    items:
                      $ref: '#/components/schemas/Lead'
                  total:
                    type: integer
                    description: Rows matching the current filter.
                  workspaceTotal:
                    type: integer
                    description: Every lead the workspace stores, ignoring filters.
                  customColumns:
                    type: array
                    items:
                      type: string
                  customFields:
                    type: array
                    items:
                      $ref: '#/components/schemas/LeadField'
                  campaigns:
                    type: array
                    description: Past lead searches, with how many leads each produced.
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          format: uuid
                        label:
                          type: string
                        count:
                          type: integer
                        created_at:
                          type: string
                          format: date-time
                          nullable: true
                  leadLimit:
                    type: integer
                    description: Stored-lead cap for the plan.
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    Lead:
      type: object
      properties:
        id:
          type: string
          format: uuid
        company:
          type: string
          nullable: true
        full_name:
          type: string
          nullable: true
        title:
          type: string
          nullable: true
        email:
          type: string
          nullable: true
        phone:
          type: string
          nullable: true
        domain:
          type: string
          nullable: true
        linkedin_url:
          type: string
          nullable: true
        location:
          type: string
          nullable: true
        source_url:
          type: string
          nullable: true
        score:
          type: integer
          nullable: true
        status:
          type: string
          enum:
            - new
            - qualified
            - contacted
            - disqualified
        custom:
          type: object
          description: Values for the workspace's declared custom columns.
        email_status:
          type: string
          nullable: true
          enum:
            - valid
            - invalid
            - catch_all
            - no_mx
            - disposable
            - unknown
        email_provider:
          type: string
          nullable: true
        email_is_role:
          type: boolean
          nullable: true
        email_validated_at:
          type: string
          format: date-time
          nullable: true
        unsubscribed_at:
          type: string
          format: date-time
          nullable: true
        archived_at:
          type: string
          format: date-time
          nullable: true
        agent_run_id:
          type: string
          format: uuid
          nullable: true
          description: The lead search that produced this lead.
        created_at:
          type: string
          format: date-time
    LeadField:
      type: object
      properties:
        key:
          type: string
        label:
          type: string
        type:
          type: string
        description:
          type: string
          nullable: true
        auto_research:
          type: boolean
          description: The agent fills this in on future lead searches.
        declared:
          type: boolean
    Error:
      type: object
      properties:
        error:
          type: string
          description: Human-readable message.
        code:
          type: string
          description: >-
            A machine-readable code on gated failures: `lead_limit`,
            `outreach_locked`, `validation_credits_exhausted`.
  responses:
    Unauthorized:
      description: >-
        Missing, invalid or expired credential — or a key that lacks the
        permission this route requires.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        A ManyPI API key (`mpi_...`) from Settings → API keys, or an OAuth 2.1
        access token obtained through the MCP consent flow.

````