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

# List ReadyLink leads

> Returns the user's leads from ReadyLinks, with filters, pagination, and sort. Response is wrapped: `{ data: Lead[], pagination: {...}, filters: {...} }`.

Lead `surveyStatus` (the survey's own status) takes values `pending`, `completed`, `converted`, `archived`. The `status` query parameter (`active`, `archived`, `all`) toggles between active vs archived view.



## OpenAPI

````yaml /api-reference/openapi.json get /api/lead-generation/leads
openapi: 3.1.0
info:
  title: Audity Agent API
  version: 1.0.0
  summary: >-
    The agent-facing surface of Audity AI: projects, leads, Nucleus, and
    account.
  description: >-
    Audity is a B2B SaaS for consultants who run automated business audits. This
    API is the agent-facing slice: a deliberately small set of task-shaped
    endpoints that lets external AI agents (Claude, ChatGPT, Cursor, n8n) act on
    a consultant's Audity workspace on their behalf.


    **Authentication:** Bearer token (`aky_...`) issued from
    `https://app.auditynow.com/dashboard/settings/api-tokens`. The middleware
    resolves the token to a Clerk user identity; tier and Row-Level Security
    gates apply automatically.


    **Rate limits:** reads 100/min, writes 20/min, async job polling 120/min;
    some expensive or high-volume endpoints have stricter caps. 429 responses
    include `Retry-After`.


    **Tier gating:** public plan names can change faster than API enum names.
    Use `GET /api/user/tier` and any `requiredTier` field in 403 responses as
    the source of truth for a specific account. Read-only or
    lead-generation-focused plans can read available data; audit-capable paid
    plans unlock writes, subject to token scope and credits.
  contact:
    name: Audity Support
    email: support@auditynow.com
    url: https://app.auditynow.com
  license:
    name: Proprietary
    identifier: LicenseRef-Audity-Proprietary
  termsOfService: https://auditynow.com/terms
servers:
  - url: https://app.auditynow.com
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Projects
    description: >-
      Audit project lifecycle, create, list, fetch, trigger analysis, get
      deliverables.
  - name: Leads
    description: ReadyLink-sourced leads, list, fetch, convert into projects.
  - name: Nucleus
    description: >-
      Nucleus is Audity's persistent memory + insight layer. Search memories,
      capture notes, read proactive insights, manage contacts.
  - name: Account
    description: Identity, tier, credits, usually called once per session for context.
  - name: ReadyLinks
    description: >-
      Manage ReadyLinks, the survey distribution links that generate leads. CRUD
      operations for links, customization, lead tracking.
  - name: Assessment Configs
    description: >-
      Manage assessment configurations that define survey questions, order,
      scoring, and customization.
  - name: Jobs
    description: >-
      Monitor async job status for long-running operations like audit analysis
      synthesis.
paths:
  /api/lead-generation/leads:
    get:
      tags:
        - Leads
      summary: List ReadyLink leads
      description: >-
        Returns the user's leads from ReadyLinks, with filters, pagination, and
        sort. Response is wrapped: `{ data: Lead[], pagination: {...}, filters:
        {...} }`.


        Lead `surveyStatus` (the survey's own status) takes values `pending`,
        `completed`, `converted`, `archived`. The `status` query parameter
        (`active`, `archived`, `all`) toggles between active vs archived view.
      operationId: listLeads
      parameters:
        - name: status
          in: query
          required: false
          schema:
            type: string
            enum:
              - active
              - archived
              - all
            default: active
        - name: staticSlugId
          in: query
          required: false
          description: Filter to leads from a specific ReadyLink (UUID).
          schema:
            type: string
            format: uuid
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 500
            default: 50
        - name: offset
          in: query
          required: false
          schema:
            type: integer
            minimum: 0
            default: 0
        - name: sortBy
          in: query
          required: false
          schema:
            type: string
            enum:
              - created_at
              - updated_at
              - client_name
              - business_name
              - ai_readiness_score
              - composite_score
            default: created_at
        - name: sortOrder
          in: query
          required: false
          schema:
            type: string
            enum:
              - asc
              - desc
            default: desc
      responses:
        '200':
          description: Paginated leads
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LeadsListResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    LeadsListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/LeadSummary'
        pagination:
          type: object
          properties:
            limit:
              type: integer
            offset:
              type: integer
            total:
              type:
                - integer
                - 'null'
        filters:
          type: object
          description: Echo of the filters applied.
          additionalProperties: true
      required:
        - data
        - pagination
    LeadSummary:
      type: object
      properties:
        id:
          type: string
          format: uuid
        clientName:
          type:
            - string
            - 'null'
        businessName:
          type:
            - string
            - 'null'
        clientEmail:
          type:
            - string
            - 'null'
        clientPhone:
          type:
            - string
            - 'null'
        aiReadinessScore:
          type:
            - number
            - 'null'
        compositeScore:
          type:
            - number
            - 'null'
        webResearchStatus:
          type:
            - string
            - 'null'
        surveyStatus:
          type: string
          enum:
            - pending
            - completed
            - converted
            - archived
        staticSlugId:
          type:
            - string
            - 'null'
          format: uuid
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
      required:
        - id
        - surveyStatus
        - createdAt
    Error:
      type: object
      properties:
        error:
          type: string
          description: Human-readable error message.
        details:
          type: string
          description: Additional context (development only).
      required:
        - error
  responses:
    Unauthorized:
      description: Missing or invalid token.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Unauthorized
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Audity Personal Access Token (aky_...)
      description: >-
        A Personal Access Token issued from
        https://app.auditynow.com/dashboard/settings/api-tokens. Format:
        `aky_<32 random chars>`.

````