> ## 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.

# List extracted filing forms

> Read stored SERFF form-schedule metadata in live row-ID order. No acquisition or extraction is started. Empty results do not establish that the filing has no forms. Keep filing ID and limit unchanged when continuing; cursors expire after 24 hours. Re-extraction can replace row IDs, so deduplicate or restart for a fresh view.



## OpenAPI

````yaml /openapi.json get /filings/{filingId}/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:
  /filings/{filingId}/forms:
    get:
      tags:
        - Filings
      summary: List extracted filing forms
      description: >-
        Read stored SERFF form-schedule metadata in live row-ID order. No
        acquisition or extraction is started. Empty results do not establish
        that the filing has no forms. Keep filing ID and limit unchanged when
        continuing; cursors expire after 24 hours. Re-extraction can replace row
        IDs, so deduplicate or restart for a fresh view.
      operationId: listFilingForms
      parameters:
        - schema:
            type: string
            format: uuid
          required: true
          name: filingId
          in: path
        - schema:
            type: integer
            minimum: 1
            maximum: 200
            default: 50
          required: false
          name: limit
          in: query
        - schema:
            type: string
            minLength: 1
            maxLength: 128
          required: false
          name: cursor
          in: query
      responses:
        '200':
          description: A page of extracted forms, with available PDF references.
          content:
            application/json:
              schema:
                type: object
                properties:
                  filingId:
                    type: string
                    format: uuid
                  forms:
                    type: array
                    items:
                      $ref: '#/components/schemas/V2FilingForm'
                  nextCursor:
                    type: string
                    nullable: true
                  availability:
                    type: object
                    properties:
                      sourceSupported:
                        type: boolean
                        description: >-
                          True for SERFF; these extractions are not available
                          for Florida IRFS.
                      sourceCompleteness:
                        type: string
                        enum:
                          - unknown
                        description: >-
                          Stored extracted data is not proof of a complete
                          source schedule or rate analysis.
                    required:
                      - sourceSupported
                      - sourceCompleteness
                required:
                  - filingId
                  - forms
                  - nextCursor
                  - availability
        '400':
          description: Invalid request or 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: Filing not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '409':
          description: File-reference inventory exceeds traversal limits.
          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. Retry-After is in seconds.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
      security:
        - bearerAuth: []
components:
  schemas:
    V2FilingForm:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: >-
            Extracted schedule-row ID. Re-extraction may replace it; it is not a
            form lineage ID.
        formNumber:
          type: string
          nullable: true
        formName:
          type: string
          nullable: true
        editionDate:
          type: string
          nullable: true
          format: date
        formType:
          type: string
          nullable: true
        formTypeNormalized:
          type: string
          nullable: true
        formAction:
          type: string
          nullable: true
        previousFilingNumber:
          type: string
          nullable: true
        replacedFormNumber:
          type: string
          nullable: true
        replacedEditionDate:
          type: string
          nullable: true
          format: date
        applicableStates:
          type: array
          nullable: true
          items:
            type: string
        topicTags:
          type: array
          nullable: true
          items:
            type: string
        file:
          type: object
          nullable: true
          properties:
            fileId:
              type: string
              format: uuid
            versionId:
              type: string
              nullable: true
              description: >-
                Current stored version, when known; not the version from which
                the form metadata was extracted.
          required:
            - fileId
            - versionId
          description: >-
            Caller-visible matched PDF in this filing. Null if no accessible
            match is available. Matching is inferred from the form number and
            filename; verify the PDF.
      required:
        - id
        - formNumber
        - formName
        - editionDate
        - formType
        - formTypeNormalized
        - formAction
        - previousFilingNumber
        - replacedFormNumber
        - replacedEditionDate
        - applicableStates
        - topicTags
        - file
    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
    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.