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

# Get recorded product forms in a state

> Recorded component note and shared file references. Empty means nothing recorded. A file may serve multiple components. Downloads use GET /files/{fileId}/download with its existing access/export checks.



## OpenAPI

````yaml /openapi.json get /insurance/products/{productId}/availability/{state}/forms
openapi: 3.0.3
info:
  title: Effective API
  version: 2.0.0
  description: The public Effective REST API. Authenticate using an Effective API key.
servers:
  - url: https://canary.effectiveai.app/api/v2
    description: Canary
security:
  - bearerAuth: []
paths:
  /insurance/products/{productId}/availability/{state}/forms:
    get:
      tags:
        - Products
      summary: Get recorded product forms in a state
      description: >-
        Recorded component note and shared file references. Empty means nothing
        recorded. A file may serve multiple components. Downloads use GET
        /files/{fileId}/download with its existing access/export checks.
      operationId: getAvailabilityForms
      parameters:
        - schema:
            type: string
            description: >-
              Managed product_ ID or bare checked code; case-insensitive with
              Crockford aliases.
          required: true
          description: >-
            Managed product_ ID or bare checked code; case-insensitive with
            Crockford aliases.
          name: productId
          in: path
        - schema:
            type: string
            minLength: 1
            maxLength: 200
          required: true
          name: state
          in: path
      responses:
        '200':
          description: Component note and files.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2ProductDocuments'
        '400':
          description: >-
            Invalid request, invalid_id or invalid_cursor; restart traversal for
            an invalid cursor.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '401':
          description: Authentication required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '403':
          description: Operation forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '404':
          description: Product or availability not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '429':
          description: Rate limited. Honor Retry-After seconds.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '500':
          description: Unexpected server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '503':
          description: Dependency unavailable. Honor Retry-After seconds.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
      security:
        - bearerAuth: []
components:
  schemas:
    V2ProductDocuments:
      type: object
      properties:
        note:
          type: string
          nullable: true
        files:
          type: array
          items:
            $ref: '#/components/schemas/V2ProductFileRef'
      required:
        - note
        - files
      additionalProperties: false
    V2CodedError:
      allOf:
        - $ref: '#/components/schemas/V2Error'
        - type: object
          properties:
            code:
              type: string
              minLength: 1
              description: Stable error code. Clients must tolerate unknown future codes.
            details:
              type: array
              items:
                type: object
                properties:
                  location:
                    type: string
                    enum:
                      - path
                      - query
                      - header
                      - body
                  path:
                    type: array
                    items:
                      type: string
                      maxLength: 64
                    maxItems: 12
                  code:
                    type: string
                    enum:
                      - required
                      - invalid_type
                      - invalid_value
                      - unknown_field
                  message:
                    type: string
                    minLength: 1
                    maxLength: 200
                required:
                  - location
                  - path
                  - code
                  - message
              minItems: 1
              maxItems: 20
              description: Bounded safe validation issues; may omit some invalid fields.
            requestId:
              type: string
              minLength: 1
              maxLength: 128
              description: >-
                Existing server correlation for this HTTP attempt, when
                available.
          required:
            - code
    V2ProductFileRef:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        source:
          type: string
          enum:
            - serff
            - web
        url:
          type: string
          nullable: true
          format: uri
        filing:
          type: object
          nullable: true
          properties:
            id:
              type: string
              format: uuid
            trackingNumber:
              type: string
          required:
            - id
            - trackingNumber
          additionalProperties: false
      required:
        - id
        - name
        - source
        - url
        - filing
      additionalProperties: false
    V2Error:
      type: object
      properties:
        error:
          type: string
          minLength: 1
          description: Human-readable explanation of the failure.
      required:
        - error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Effective API key. Send Authorization: Bearer sk-eai-...'

````

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