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

# Get an approval



## OpenAPI

````yaml /api-reference/endpoint/documents/openapi.json get /workspaces/approvals/{id}
openapi: 3.1.0
info:
  title: Documents API
  description: >-
    Document templates, generated documents, e-signature requests, and checkbox
    approvals. Template and document routes are served under `/file-generator`,
    approval routes under `/workspaces/approvals`.
  version: 1.2.0
servers:
  - url: https://api.quiva.ai
    description: Production API server
security:
  - bearerAuth: []
  - apiKeyAuth: []
tags:
  - name: Templates
    description: >-
      Template lifecycle — create, read, publish, validate, trigger, and delete
      document templates. Templates follow a **draft → published** model: writes
      (`POST`, `PATCH`) always target the draft version, and `POST
      /templates/{key}/publish` promotes the draft. Document generation only
      ever uses the published version, so drafts can be edited safely without
      affecting production output. A template's `source` is a DOCX file
      containing angular-expression tags rendered at trigger time.
  - name: Documents
    description: >-
      Document lifecycle — read, update, and delete generated documents. A
      document record is created immediately when a template is triggered and is
      updated asynchronously: first with the generated `output.key` (an `obj://`
      or `kv://` storage URI) or `errors`, then with `signatures` progress as
      signatories sign.
  - name: Signatures
    description: >-
      E-signature workflows powered by HelloSign (Dropbox Sign). Signature
      requests are created automatically when a triggered template defines
      `signatories`. Each signatory tracks a status lifecycle of `DRAFT → SENT →
      SIGNED`, with `EXPIRED` (validity window elapsed) and `FAILED`
      (delivery/signing error) as terminal failure states. Embedded signing URLs
      can be generated for signatures created in embedded mode.
  - name: Approvals
    description: Checkbox approval of a workspace file, recorded as e-signature evidence.
  - name: Generation
  - name: Template Source
paths:
  /workspaces/approvals/{id}:
    get:
      tags:
        - Approvals
      summary: Get an approval
      operationId: getApproval
      parameters:
        - name: id
          in: path
          required: true
          description: >-
            Approval id, or for an external signatory the signing token from the
            link.
          schema:
            type: string
      responses:
        '200':
          description: The approval
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Approval'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '410':
          description: The approval link has expired (30 days).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    Approval:
      type: object
      properties:
        id:
          type: string
        file_subject:
          type: string
        task_id:
          type: string
        created_at:
          type: string
          format: date-time
        created_by:
          type: string
        decided_at:
          type: string
          format: date-time
        status:
          type: string
          enum:
            - in_progress
            - approved
            - rejected
        signatory_internal:
          type: object
          properties:
            user_id:
              type: string
            full_name:
              type: string
            email:
              type: string
            url:
              type: string
        signatory_external:
          type: object
          properties:
            full_name:
              type: string
            email:
              type: string
            url:
              type: string
              description: >-
                Signing link carrying a random token. Expires 30 days after the
                approval is requested.
        jurisdiction:
          $ref: '#/components/schemas/Jurisdiction'
        document_hash:
          type: string
          readOnly: true
          description: >-
            SHA-256 (hex) of the file when approval was requested. A decision is
            refused if the file has changed since.
        consent:
          type: string
          readOnly: true
          description: The statement the signatory agrees to, set on read.
        sign_places:
          type: array
          readOnly: true
          items:
            type: string
            enum:
              - signature
              - initials
          description: What the signatory must fill in before approving.
    ErrorResponse:
      type: object
      properties:
        error:
          type: string
          example: '"key" is required'
    Jurisdiction:
      type: string
      enum:
        - AU
        - NZ
        - UK
        - US
      default: AU
      description: >-
        Sets the consent text the signatory sees. `US` adds the ESIGN consumer
        disclosures.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.