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

# Get Proposal Status

> Get only the status of a proposal (lightweight endpoint for polling).

**Required scope:** `read`

Use this endpoint for:
- n8n workflows that wait for client response
- Polling proposal status without fetching full data
- Webhook verification

Returns minimal data: id, status, name, client_name, total, updated_at, share_info



## OpenAPI

````yaml /openapi/openapi-external.json get /proposals/{proposal_id}/status
openapi: 3.1.0
info:
  title: Quikly.ai External API
  version: 1.0.0
  description: >-
    REST API for external integrations with Quikly.ai. Authenticate using an API
    key passed in the X-API-Key header. Use these endpoints from n8n, Zapier,
    custom scripts, or any HTTP client.
servers: []
security:
  - ApiKeyAuth: []
tags:
  - name: Proposals
    description: Create, read, update, and manage client proposals.
  - name: Profile
    description: Read and update the authenticated user's profile.
  - name: Templates
    description: Manage reusable proposal templates.
  - name: AI Services
    description: >-
      AI-powered analysis: rate recommendations, brief analysis,
      differentiators.
  - name: Public API
  - name: Usage
    description: Query API usage and quota information.
  - name: Webhooks
    description: Manage webhook subscriptions for real-time events.
  - name: Agent
    description: Interact with the AI agent for automated workflows.
  - name: Lead Sessions
    description: Track and manage lead capture sessions.
paths:
  /proposals/{proposal_id}/status:
    get:
      tags:
        - Proposals
      summary: Get Proposal Status
      description: >-
        Get only the status of a proposal (lightweight endpoint for polling).


        **Required scope:** `read`


        Use this endpoint for:

        - n8n workflows that wait for client response

        - Polling proposal status without fetching full data

        - Webhook verification


        Returns minimal data: id, status, name, client_name, total, updated_at,
        share_info
      operationId: get_proposal_status_api_external_v1_proposals__proposal_id__status_get
      parameters:
        - name: proposal_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: Proposal Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProposalStatusResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - APIKeyHeader: []
components:
  schemas:
    ProposalStatusResponse:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        status:
          type: string
          title: Status
        name:
          type: string
          title: Name
        client_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Client Name
        total:
          anyOf:
            - type: number
            - type: 'null'
          title: Total
        currency:
          type: string
          title: Currency
          default: USD
        updated_at:
          type: string
          format: date-time
          title: Updated At
        share_info:
          anyOf:
            - type: object
            - type: 'null'
          title: Share Info
      type: object
      required:
        - id
        - status
        - name
        - updated_at
      title: ProposalStatusResponse
      description: Response with just proposal status - lightweight for polling.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: API key obtained from Quikly.ai Settings → API Keys.
    APIKeyHeader:
      type: apiKey
      in: header
      name: X-API-Key

````