> ## 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 the user's audit projects

> Returns all of the user's audit projects, ordered by most recently updated. Each project includes status flags (`hasAnalysis`, `hasInterviewAnalysis`, `hasAuditAnalysis`, `hasDeliverables`), document and stakeholder counts, and a calculated `analysisProgress` percentage. Sorted to surface projects with documents first.



## OpenAPI

````yaml /api-reference/openapi.json get /api/projects
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/projects:
    get:
      tags:
        - Projects
      summary: List the user's audit projects
      description: >-
        Returns all of the user's audit projects, ordered by most recently
        updated. Each project includes status flags (`hasAnalysis`,
        `hasInterviewAnalysis`, `hasAuditAnalysis`, `hasDeliverables`), document
        and stakeholder counts, and a calculated `analysisProgress` percentage.
        Sorted to surface projects with documents first.
      operationId: listProjects
      responses:
        '200':
          description: Array of project summaries
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ProjectSummary'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/ServerError'
components:
  schemas:
    ProjectSummary:
      allOf:
        - $ref: '#/components/schemas/Project'
        - type: object
          properties:
            documentsCount:
              type: integer
            analysisProgress:
              type: integer
              minimum: 0
              maximum: 100
              description: >-
                Percentage 0-100 representing how far through the audit
                lifecycle this project is.
            stakeholdersCount:
              type: integer
            hasAnalysis:
              type: boolean
            hasInterviewAnalysis:
              type: boolean
            hasAuditAnalysis:
              type: boolean
            hasQuestionnaires:
              type: boolean
            hasDeliverables:
              type: boolean
            statusLabel:
              type: string
            statusDescription:
              type: string
            lastActivity:
              type:
                - object
                - 'null'
              properties:
                type:
                  type: string
                  enum:
                    - document_upload
                    - analysis_generated
                    - interview_completed
                date:
                  type: string
                  format: date-time
                description:
                  type: string
    Project:
      type: object
      properties:
        id:
          type: string
          format: uuid
        clientName:
          type: string
        industry:
          type: string
        companySize:
          type: string
        description:
          type:
            - string
            - 'null'
        currency:
          type: string
        status:
          $ref: '#/components/schemas/ProjectStatus'
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
      required:
        - id
        - clientName
        - industry
        - companySize
        - status
        - createdAt
    Error:
      type: object
      properties:
        error:
          type: string
          description: Human-readable error message.
        details:
          type: string
          description: Additional context (development only).
      required:
        - error
    ProjectStatus:
      type: string
      enum:
        - setup
        - analysis
        - interviews
        - complete
        - archived
      description: Lifecycle state of an audit project.
  responses:
    Unauthorized:
      description: Missing or invalid token.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Unauthorized
    RateLimited:
      description: Rate limit exceeded.
      headers:
        Retry-After:
          schema:
            type: integer
          description: Seconds to wait before retrying.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    ServerError:
      description: Internal server error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  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>`.

````