> ## 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 immutable program versions

> Free authenticated version metadata, newest first. Use nextBefore as before for the next page. Dates and limitations are recorded metadata; bundle object keys are never returned.



## OpenAPI

````yaml /openapi.json get /insurance/rating-programs/{id}/versions
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/rating-programs/{id}/versions:
    get:
      tags:
        - Rating programs
      summary: List immutable program versions
      description: >-
        Free authenticated version metadata, newest first. Use nextBefore as
        before for the next page. Dates and limitations are recorded metadata;
        bundle object keys are never returned.
      operationId: listRatingProgramVersions
      parameters:
        - schema:
            type: string
            pattern: ^[a-z0-9][a-z0-9._-]{0,127}$
          required: true
          name: id
          in: path
        - schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 25
          required: false
          name: limit
          in: query
        - schema:
            type: integer
            minimum: 0
            exclusiveMinimum: true
          required: false
          name: before
          in: query
      responses:
        '200':
          description: Newest versions first. Pass nextBefore as before for the next page.
          content:
            application/json:
              schema:
                type: object
                properties:
                  versions:
                    type: array
                    items:
                      $ref: '#/components/schemas/V2RatingProgramVersion'
                  nextBefore:
                    type: number
                    nullable: true
                required:
                  - versions
                  - nextBefore
                additionalProperties: false
        '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: Program entitlement and user permission are required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '404':
          description: Program, version or package not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '409':
          description: Stored bundle identity differs.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '413':
          description: Input exceeds the size limit.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '422':
          description: Invalid inputs or business refusal.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '429':
          description: Rating capacity unavailable; honor Retry-After.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '500':
          description: Unexpected failure.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '503':
          description: Dependency unavailable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
      security:
        - bearerAuth: []
components:
  schemas:
    V2RatingProgramVersion:
      type: object
      properties:
        engineBundleId:
          type: string
          pattern: ^[a-f0-9]{64}$
        programBundleId:
          type: string
          nullable: true
          pattern: ^[a-f0-9]{64}$
        effectiveDate:
          type: string
          nullable: true
          format: date
        supportedFrom:
          type: string
          nullable: true
          format: date
        supportedTo:
          type: string
          nullable: true
          format: date
        scopeNote:
          type: string
          nullable: true
          maxLength: 100000
        releaseNotes:
          type: string
          nullable: true
          maxLength: 100000
        programId:
          type: string
          pattern: ^[a-z0-9][a-z0-9._-]{0,127}$
        version:
          type: integer
          minimum: 0
          exclusiveMinimum: true
        publishedAt:
          type: string
          format: date-time
        publishedBy:
          type: string
      required:
        - engineBundleId
        - programBundleId
        - effectiveDate
        - supportedFrom
        - supportedTo
        - scopeNote
        - releaseNotes
        - programId
        - version
        - publishedAt
        - publishedBy
      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.
            dataset:
              type: string
              enum:
                - naic
              description: Dataset needed for dataset_not_enabled.
            accessUrl:
              type: string
              nullable: true
              format: uri
              description: >-
                Where to add the product to your account, for
                product_access_required.
          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.