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

# List a framework's rules

> List the rules that belong to a framework.

To read the compliance status of these rules, use
[List rule results](/api-reference/rest/governance/list-rule-results) with the `frameworkId`
filter, or fetch the results of an individual rule.




## OpenAPI

````yaml get /frameworks/{frameworkId}/rules
openapi: 3.0.3
info:
  contact:
    email: support@openlayer.com
    name: Openlayer
    url: https://openlayer.com/
  description: API for interacting with the Openlayer server.
  title: Openlayer API
  version: '1.0'
  x-logo:
    url: https://logo.clearbit.com/openlayer.com
servers:
  - url: https://api.openlayer.com/v1
    description: Our prod backend
security:
  - bearerAuth: []
paths:
  /frameworks/{frameworkId}/rules:
    get:
      tags:
        - Governance
      summary: List a framework's rules
      description: >
        List the rules that belong to a framework.


        To read the compliance status of these rules, use

        [List rule results](/api-reference/rest/governance/list-rule-results)
        with the `frameworkId`

        filter, or fetch the results of an individual rule.
      operationId: listFrameworkRules
      parameters:
        - $ref: '#/components/parameters/frameworkId'
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/perPage'
      responses:
        '200':
          description: Status OK.
          content:
            application/json:
              schema:
                type: object
                required:
                  - items
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/Rule'
        default:
          $ref: '#/components/responses/UnexpectedError'
      x-codeSamples:
        - lang: curl
          source: |
            curl --request GET \
              --url https://api.openlayer.com/v1/frameworks/9f1b3c2d-4e5a-4f60-8a71-2b3c4d5e6f70/rules \
              --header 'Authorization: Bearer <token>'
components:
  parameters:
    frameworkId:
      name: frameworkId
      in: path
      description: The framework id.
      required: true
      schema:
        type: string
        format: uuid
    page:
      name: page
      in: query
      description: The page to return in a paginated query.
      schema:
        type: integer
        minimum: 1
        default: 1
    perPage:
      name: perPage
      in: query
      description: Maximum number of items to return per page.
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 25
  schemas:
    Rule:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
          description: The rule id.
          example: 7c9a1e2b-3d4f-4a5b-8c6d-7e8f9a0b1c2d
        workspaceId:
          type: string
          format: uuid
          readOnly: true
          description: The id of the workspace the rule belongs to.
        name:
          type: string
          maxLength: 255
          description: The rule name.
          example: Monitoring enabled
        description:
          type: string
          nullable: true
          description: What the rule requires.
          example: Each project must have Openlayer monitoring mode enabled.
        scope:
          type: string
          enum:
            - project
            - workspace
          description: >
            Whether the rule is evaluated once for the whole workspace, or once
            per project the rule's frameworks apply to.
          example: project
        type:
          type: string
          enum:
            - platform
            - evidence
          description: >
            `platform` rules are evaluated automatically from the state of your
            Openlayer workspace. `evidence` rules are satisfied by attaching
            evidence.
          example: platform
        evidenceType:
          type: string
          nullable: true
          enum:
            - document
            - text
            - url
            - categoryValue
            - null
          description: >-
            The kind of evidence that satisfies the rule. `null` for platform
            rules.
        renewalCadenceDays:
          type: integer
          nullable: true
          minimum: 1
          description: >
            How often evidence must be renewed, in days. Once evidence is older
            than this, the rule result becomes `due_soon` and then `failing`.
          example: 90
        automationType:
          type: string
          nullable: true
          description: >
            Which workspace signal a platform rule checks, for example
            `monitoring_mode_enabled`, `test_setup`, or `project_owner_set`.
            `null` for evidence rules.
          example: monitoring_mode_enabled
        automationParams:
          type: object
          nullable: true
          additionalProperties: true
          description: >-
            Configuration for the platform check, when the automation takes
            parameters.
        deactivated:
          type: boolean
          default: false
          description: Whether the rule is excluded from compliance calculations.
        assigneeId:
          type: string
          format: uuid
          nullable: true
          description: The user responsible for satisfying the rule.
        tagIds:
          type: array
          nullable: true
          writeOnly: true
          description: >
            The ids of the rule tags to associate with the rule. Replaces the
            rule's tags. Read them back from `tags`, and list the tags available
            in the workspace with `GET /workspaces/{workspaceId}/rule-tags`.
          items:
            type: string
            format: uuid
        tags:
          type: array
          nullable: true
          readOnly: true
          description: The rule tags associated with the rule.
          items:
            $ref: '#/components/schemas/RuleTag'
        frameworks:
          type: array
          readOnly: true
          description: The frameworks that include this rule.
          items:
            type: object
            required:
              - id
              - name
              - avatar
              - builtInSlug
              - enabled
            properties:
              id: 4314273e-8fb5-4afd-b597-20b68c151e32
              name: 7f23bb66-0d42-497f-867b-b30c58d7a5f8
              avatar: b7271b5a-9232-442f-80e6-0c2686351bfe
              builtInSlug: 92c9038f-0b80-48ed-9f0c-f5cc6a3a17f0
              enabled: 075672ed-32b5-457d-9797-b2fe9170a5bd
        results:
          type: array
          readOnly: true
          description: >
            The rule's results, one per entity the rule is evaluated against.
            Only returned when `includeResults` is `true`.
          items:
            $ref: '#/components/schemas/RuleResult'
        resultsSummary:
          type: object
          nullable: true
          readOnly: true
          description: >
            Pass-rate counts across all of the rule's entities, independent of
            any status filter applied to the request.
          properties:
            passing:
              type: integer
              minimum: 0
            total:
              type: integer
              minimum: 0
        immutable:
          type: boolean
          readOnly: true
          description: Whether the rule is managed by Openlayer and cannot be edited.
        dateCreated:
          type: string
          format: date-time
          readOnly: true
          description: The creation date.
          example: '2026-03-22T11:31:01.185Z'
        dateUpdated:
          type: string
          format: date-time
          readOnly: true
          description: The last update date.
          example: '2026-03-22T11:31:01.185Z'
      required:
        - id
        - workspaceId
        - name
        - scope
        - type
        - dateCreated
        - dateUpdated
    RuleTag:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
          description: The rule tag id.
          example: 6e8a0c2d-4f5b-4a3c-9d7e-8f0a1b2c3d4e
        workspaceId:
          type: string
          format: uuid
          readOnly: true
          description: The id of the workspace the tag belongs to.
        creatorId:
          type: string
          format: uuid
          nullable: true
          readOnly: true
          description: >-
            The user who created the tag. `null` for tags that ship with
            Openlayer.
        name:
          type: string
          maxLength: 255
          description: The tag name.
          example: Evaluation
        color:
          type: string
          maxLength: 50
          nullable: true
          description: The color the tag is displayed with.
        immutable:
          type: boolean
          default: false
          readOnly: true
          description: >-
            Whether the tag is managed by Openlayer and cannot be edited or
            deleted.
        dateCreated:
          type: string
          format: date-time
          readOnly: true
          description: The creation date.
          example: '2026-03-22T11:31:01.185Z'
        dateUpdated:
          type: string
          format: date-time
          readOnly: true
          description: The last update date.
          example: '2026-03-22T11:31:01.185Z'
      required:
        - id
        - workspaceId
        - creatorId
        - name
        - immutable
        - dateCreated
        - dateUpdated
    RuleResult:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
          description: The rule result id.
          example: 5b7d9f1a-2c3e-4d5f-8a6b-9c0d1e2f3a4b
        workspaceId:
          type: string
          format: uuid
          readOnly: true
          description: The id of the workspace the rule result belongs to.
        ruleId:
          type: string
          format: uuid
          readOnly: true
          description: The rule this result belongs to.
        projectId:
          type: string
          format: uuid
          nullable: true
          readOnly: true
          description: >-
            The project this result was evaluated for. `null` for
            workspace-scoped rules.
        status:
          type: string
          enum:
            - running
            - passing
            - failing
            - skipped
            - error
            - pending
            - due_soon
          description: The compliance status of the rule for this entity.
          example: passing
        statusMessage:
          type: string
          nullable: true
          description: A human-readable explanation of the status.
        dateLastEvaluated:
          type: string
          format: date-time
          nullable: true
          readOnly: true
          description: When the rule was last evaluated. Platform rules only.
        dateOfNextEvaluation:
          type: string
          format: date-time
          nullable: true
          readOnly: true
          description: When the rule will next be evaluated. Platform rules only.
        dateOfLatestEvidence:
          type: string
          format: date-time
          nullable: true
          readOnly: true
          description: >-
            When the most recent piece of evidence was attached. Evidence rules
            only.
        dateOfRenewal:
          type: string
          format: date-time
          nullable: true
          readOnly: true
          description: >-
            When the evidence must be renewed. Evidence rules with a renewal
            cadence only.
        deactivated:
          type: boolean
          default: false
          description: Whether this result is excluded from compliance calculations.
        deactivatedReason:
          type: string
          nullable: true
          description: Why the result was excluded.
        assigneeId:
          type: string
          format: uuid
          nullable: true
          description: The user responsible for this result.
        blockedBy:
          type: array
          default: []
          description: Rule results that must pass before this one can be satisfied.
          items:
            type: object
            properties:
              id:
                type: string
                format: uuid
              status: f8525691-88dc-400b-a084-7ed44d40a6d2
        blocking:
          type: array
          default: []
          description: Rule results that this one blocks.
          items:
            type: object
            properties:
              id:
                type: string
                format: uuid
              status: f8525691-88dc-400b-a084-7ed44d40a6d2
        dateCreated:
          type: string
          format: date-time
          readOnly: true
          description: The creation date.
          example: '2026-03-22T11:31:01.185Z'
        dateUpdated:
          type: string
          format: date-time
          readOnly: true
          description: The last update date.
          example: '2026-03-22T11:31:01.185Z'
      required:
        - id
        - workspaceId
        - ruleId
        - status
        - deactivated
        - dateCreated
        - dateUpdated
  responses:
    UnexpectedError:
      description: Unexpected error.
      content:
        application/json:
          schema:
            type: object
            required:
              - code
              - error
            properties:
              code:
                type: integer
                format: int32
              error:
                type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >
        Bearer authentication header of the form `Bearer <token>`, where
        `<token>` is your workspace API key. See [Find your API
        key](https://www.openlayer.com/docs/workspace-and-projects/find-your-api-key)
        for more information.

````