> ## 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 a product's underwriting guidelines

> List the underwriting guidelines a managed product owns, most recently added first, each at its latest version. A product can own several, for example one per state or channel; a submission picks one when its file is opened. Requires `scope` (`mc:<scope UUID or slug>`) and read access to the product; read-only keys work. To paginate, pass `nextCursor` as `cursor` with the same `scope`, `productId` and `limit` until it is null. Get one with `getUwGuidelines`.



## OpenAPI

````yaml /openapi.json get /insurance/uw-guidelines
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/uw-guidelines:
    get:
      tags:
        - Underwriting
      summary: List a product's underwriting guidelines
      description: >-
        List the underwriting guidelines a managed product owns, most recently
        added first, each at its latest version. A product can own several, for
        example one per state or channel; a submission picks one when its file
        is opened. Requires `scope` (`mc:<scope UUID or slug>`) and read access
        to the product; read-only keys work. To paginate, pass `nextCursor` as
        `cursor` with the same `scope`, `productId` and `limit` until it is
        null. Get one with `getUwGuidelines`.
      operationId: listUwGuidelines
      parameters:
        - schema:
            type: string
            pattern: ^mc:[A-Za-z0-9][A-Za-z0-9-]{0,127}$
            description: Authorization scope UUID or stable slug prefixed with mc:.
          required: true
          description: Authorization scope UUID or stable slug prefixed with mc:.
          name: scope
          in: query
        - schema:
            type: string
            format: uuid
            description: The managed product whose guidelines to list.
          required: true
          description: The managed product whose guidelines to list.
          name: productId
          in: query
        - schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 50
            description: Maximum number of items to return (1-100, default 50).
          required: false
          description: Maximum number of items to return (1-100, default 50).
          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
      responses:
        '200':
          description: One page of guidelines.
          content:
            application/json:
              schema:
                type: object
                properties:
                  guidelines:
                    type: array
                    items:
                      $ref: '#/components/schemas/V2UwGuidelines'
                  nextCursor:
                    type: string
                    nullable: true
                    description: Cursor for the next page, or null on the last page.
                required:
                  - guidelines
                  - nextCursor
                additionalProperties: false
        '400':
          description: >-
            Invalid request, or guidelines or an input the guidelines cannot
            use; `details` lists each problem. Restart a list after
            `invalid_cursor`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '401':
          description: Authentication required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '403':
          description: Credential or scope access denied, or the change is not permitted.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '404':
          description: Scope, product, guidelines, submission, file or input not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '409':
          description: >-
            The resource changed or already exists: read it again before
            retrying.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '413':
          description: Request body is too large.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '415':
          description: Content-Type must be application/json.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '500':
          description: Unexpected server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '503':
          description: Temporarily unavailable. Honor Retry-After in seconds.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
      security:
        - bearerAuth: []
components:
  schemas:
    V2UwGuidelines:
      type: object
      properties:
        id:
          type: string
          description: Stable guidelines ID.
        productId:
          type: string
          description: The managed product that owns these guidelines.
        name:
          type: string
        fileId:
          type: string
          description: >-
            The stored `.uw.md` file. Read a version with `downloadFile` and
            `versionId`.
        versionId:
          type: string
          description: The latest version, which a newly opened file is pinned to.
        version:
          type: integer
          description: Latest version number, starting at 1.
        updatedAt:
          type: string
          format: date-time
          description: When the latest version was saved.
      required:
        - id
        - productId
        - name
        - fileId
        - versionId
        - version
        - updatedAt
    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.
            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.