> ## 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 form comparisons

> Not implemented yet: returns 501 until the implementation ships. List your organization's form comparisons, newest first, with their status and variant keys. Read getFormComparison for results. Filter by repeating status. Pass nextCursor as cursor with the same status and limit. Deleted comparisons are omitted. Listing never runs analysis and is free.



## OpenAPI

````yaml /openapi.json get /insurance/form-comparisons
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://api.canary.effectiveai.app/api/v2
    description: Canary
security:
  - bearerAuth: []
paths:
  /insurance/form-comparisons:
    get:
      tags:
        - Form comparisons
      summary: List form comparisons
      description: >-
        Not implemented yet: returns 501 until the implementation ships. List
        your organization's form comparisons, newest first, with their status
        and variant keys. Read getFormComparison for results. Filter by
        repeating status. Pass nextCursor as cursor with the same status and
        limit. Deleted comparisons are omitted. Listing never runs analysis and
        is free.
      operationId: listFormComparisons
      parameters:
        - schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 20
            description: Maximum comparisons to return (1–100, default 20).
          required: false
          description: Maximum comparisons to return (1–100, default 20).
          name: limit
          in: query
        - schema:
            type: string
            minLength: 1
            maxLength: 8192
            description: >-
              Opaque nextCursor from this operation. Repeat every other query
              parameter unchanged; a cursor from a different query returns
              invalid_cursor.
          required: false
          description: >-
            Opaque nextCursor from this operation. Repeat every other query
            parameter unchanged; a cursor from a different query returns
            invalid_cursor.
          name: cursor
          in: query
        - schema:
            anyOf:
              - type: string
                enum:
                  - queued
                  - running
                  - succeeded
                  - failed
              - type: array
                items:
                  type: string
                  enum:
                    - queued
                    - running
                    - succeeded
                    - failed
                minItems: 1
                maxItems: 4
            description: >-
              Only these statuses. Repeat the key for several
              (status=queued&status=running); no commas.
            example:
              - succeeded
          required: false
          description: >-
            Only these statuses. Repeat the key for several
            (status=queued&status=running); no commas.
          name: status
          in: query
      responses:
        '200':
          description: One page of comparisons.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2FormComparisonList'
        '400':
          description: 'invalid_request or invalid_cursor: invalid query or cursor.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '401':
          description: 'unauthenticated: valid credentials are required.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '403':
          description: >-
            feature_not_enabled: the organization does not have form
            comparisons. forbidden: the credential cannot use form comparisons
            (app-scoped and delegated credentials cannot).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '500':
          description: 'internal_error: unexpected server error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '501':
          description: >-
            not_implemented: the contract is published ahead of its
            implementation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '503':
          description: 'temporarily_unavailable: retry after Retry-After seconds.'
          headers:
            Retry-After:
              required: true
              schema:
                type: integer
                minimum: 0
              description: Seconds to wait before retrying.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
      security:
        - bearerAuth: []
components:
  schemas:
    V2FormComparisonList:
      type: object
      properties:
        formComparisons:
          type: array
          items:
            $ref: '#/components/schemas/V2FormComparisonListItem'
          description: Newest first.
        nextCursor:
          type: string
          nullable: true
          description: Cursor for the next page, or null on the last page.
      required:
        - formComparisons
        - nextCursor
    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.
            dataset:
              type: string
              enum:
                - naic
                - osha
              description: Dataset needed for dataset_not_enabled.
            businessCode:
              type: string
              description: The rater’s own refusal code, for business_rejection.
            violations:
              type: array
              items:
                type: object
                properties:
                  code:
                    type: string
                    description: Authored or built-in constraint code
                  message:
                    type: string
                    description: Authored message for the failed constraint
                  path:
                    type: string
                    description: Input path of the offending value; empty for the request
                  value:
                    nullable: true
                    description: Offending input value, size-bounded by the runtime
                  constraint:
                    type: string
                    description: The constraint the value failed, as text
                  cite:
                    type: string
                    nullable: true
                    description: >-
                      Filing citation of the constraint, when the source cites
                      one
                required:
                  - code
                  - message
                  - path
                  - value
                  - constraint
                  - cite
                additionalProperties: false
              maxItems: 256
              description: >-
                Each input constraint the submission failed, for invalid_inputs
                and business_rejection.
            violationsTruncated:
              type: boolean
              description: >-
                True when the rater reported more violations than violations
                holds.
            accessUrl:
              type: string
              nullable: true
              format: uri
              description: >-
                Where to add the product to your account, for
                product_access_required.
          required:
            - code
    V2FormComparisonListItem:
      type: object
      properties:
        id:
          type: string
          description: Form comparison UUID; read it with getFormComparison.
        status:
          type: string
          enum:
            - queued
            - running
            - succeeded
            - failed
        createdAt:
          type: string
          format: date-time
        variants:
          type: array
          items:
            type: object
            properties:
              key:
                type: string
              label:
                type: string
                nullable: true
            required:
              - key
              - label
          description: Variant keys and labels from the request, in request order.
      required:
        - id
        - status
        - createdAt
        - variants
    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.