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

# List leads

> Returns a paginated list of leads for your agency.



## OpenAPI

````yaml GET /leads
openapi: 3.1.0
info:
  title: Flozy External API
  version: 1.0.0
  description: >-
    Integrate Flozy's CRM data — leads, tasks, opportunities, contacts, and
    pipelines — into your own tools and workflows.


    ## Authentication


    Send your API key on every request using **one** of:


    | Method | Example |

    |--------|---------|

    | `X-API-Key` header | `X-API-Key: flz_live_abc123…` |

    | `Authorization` header | `Authorization: Bearer flz_live_abc123…` |


    Keys start with `flz_live_` followed by 64 hex characters. Create and manage
    keys in **Settings → API Keys** (agency owners only).


    ## Rate limits


    - **100 req/min** per API key (rolling window)

    - **200 req/min** per IP (applied before key validation)


    Responses include `X-RateLimit-Limit`, `X-RateLimit-Remaining`, and
    `X-RateLimit-Reset` headers.
servers: []
security:
  - ApiKeyHeader: []
tags:
  - name: Leads
    description: >-
      Prospects and clients. The central resource — tasks, opportunities, and
      contacts all attach to leads.
  - name: Lead Statuses
    description: Status definitions for leads. Use `PUT /leads/{id}/status` to assign them.
  - name: Tasks
    description: >-
      Can be standalone or linked to a lead. Subtasks supported via
      `parent_task_id`.
  - name: Opportunities
    description: Live inside pipeline stages, always linked to a lead.
  - name: Contacts
    description: People associated with a lead. Nested under `/leads/{leadId}/contacts`.
  - name: Pipelines
    description: Read-only. Use to discover valid stage IDs.
  - name: Custom Fields
    description: Read-only. Custom field definitions for your agency.
paths:
  /leads:
    get:
      tags:
        - Leads
      summary: List leads
      description: Returns a paginated list of leads for your agency.
      operationId: listLeads
      parameters:
        - $ref: '#/components/parameters/PageParam'
        - $ref: '#/components/parameters/LimitParam'
        - $ref: '#/components/parameters/OrderParam'
        - $ref: '#/components/parameters/SearchParam'
      responses:
        '200':
          description: Paginated list of leads.
          content:
            application/json:
              example:
                http_code: 200
                status: success
                message: Leads retrieved
                data:
                  items:
                    - id: 42
                      title: Acme Corp
                      status_name: in_progress
                      status_label: In Progress
                      created_at: '2026-01-10T08:00:00.000Z'
                  pagination:
                    page: 1
                    limit: 25
                    total: 120
                    total_pages: 5
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/RateLimited'
      security:
        - ApiKeyHeader:
            - read:leads
components:
  parameters:
    PageParam:
      name: page
      in: query
      schema:
        type: integer
        default: 1
        minimum: 1
      description: Page number.
    LimitParam:
      name: limit
      in: query
      schema:
        type: integer
        default: 25
        minimum: 1
        maximum: 100
      description: Results per page (max 100).
    OrderParam:
      name: order
      in: query
      schema:
        type: string
        enum:
          - asc
          - desc
        default: desc
      description: Sort direction.
    SearchParam:
      name: search
      in: query
      schema:
        type: string
      description: Full-text search.
  responses:
    Unauthorized:
      description: Missing or invalid API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            http_code: 401
            status: failed
            message: Invalid or missing API key
    Forbidden:
      description: Valid key but insufficient scope.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            http_code: 403
            status: failed
            message: Insufficient scope
    RateLimited:
      description: Rate limit exceeded.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            http_code: 429
            status: failed
            message: Rate limit exceeded
  schemas:
    Error:
      type: object
      properties:
        http_code:
          type: integer
          example: 400
        status:
          type: string
          example: failed
        message:
          type: string
          example: Validation failed
  securitySchemes:
    ApiKeyHeader:
      type: apiKey
      in: header
      name: X-API-Key
      description: Your Flozy API key. Starts with `flz_live_`.

````