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

# List rules

> List notification rules scoped to a project.

Rules scoped to this project (for example deployment alerts).


## OpenAPI

````yaml GET /orgs/{org_id}/projects/{project_id}/notifications/rules
openapi: 3.1.0
info:
  title: Timbal Platform API
  description: Public API documentation for the Timbal platform
  license:
    name: ''
  version: 2.0.0
servers:
  - url: https://api.timbal.ai
    description: Production
  - url: https://api.dev.timbal.ai
    description: Development
security: []
tags:
  - name: ace
    description: Action Control Engine (ACE) operations
  - name: analytics
    description: Project analytics
  - name: billing
    description: Subscriptions, usage, and payment-related operations
  - name: content
    description: Re-sign stored content URLs
  - name: files
    description: File operations
  - name: iam
    description: IAM — actions, roles, users, and authorization introspection
  - name: k2
    description: Knowledge Bases v2 operations
  - name: orgs
    description: Organization operations
  - name: projects
    description: Project operations
  - name: runs
    description: Execution operations
  - name: templates
    description: Public project template catalog
  - name: users
    description: Authenticated user profile
paths:
  /orgs/{org_id}/projects/{project_id}/notifications/rules:
    get:
      tags:
        - notifications
      summary: List project notification rules
      description: List notification rules scoped to a project.
      operationId: list_project_notification_rules
      parameters:
        - name: org_id
          in: path
          required: true
          schema:
            type: string
        - name: project_id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: List of rules with channels
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListProjectNotificationRulesResBody'
        '403':
          description: Forbidden
      security:
        - bearer_auth: []
components:
  schemas:
    ListProjectNotificationRulesResBody:
      type: object
      title: ListProjectNotificationRulesResponse
      description: >-
        Wrapper for **GET**
        `/orgs/{org_id}/projects/{project_id}/notifications/rules`.
      required:
        - rules
      properties:
        rules:
          type: array
          items:
            $ref: '#/components/schemas/NotificationRuleOut'
    NotificationRuleOut:
      type: object
      required:
        - id
        - name
        - event_type
        - cooldown_seconds
        - enabled
        - channels
      properties:
        channels:
          type: array
          items:
            $ref: '#/components/schemas/NotificationChannelOut'
        condition:
          type:
            - object
            - 'null'
        cooldown_seconds:
          type: integer
          format: int32
        enabled:
          type: boolean
        event_type:
          $ref: '#/components/schemas/NotificationEventType'
        id:
          type: integer
          format: int64
        name:
          type: string
    NotificationChannelOut:
      type: object
      required:
        - id
        - type
        - config
      properties:
        config:
          type: object
        id:
          type: integer
          format: int64
        name:
          type:
            - string
            - 'null'
        type:
          $ref: '#/components/schemas/NotificationChannelType'
    NotificationEventType:
      type: string
      enum:
        - org.credits.usage
        - project.deployment.failed
        - project.deployment.running
    NotificationChannelType:
      type: string
      enum:
        - email
        - slack
  securitySchemes:
    bearer_auth:
      type: http
      scheme: bearer
      description: >-
        Timbal API key. Obtain your API key from the Timbal platform settings.
        See [Authentication](/api-reference/authentication) for more
        information.

````