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

# List recorded ordinary Automation runs

> Pass next_offset as offset to continue. Run records retain the native execution evidence field names.

> [tab] CLI Tool
>
> ```bash
> coderabbit api request "/automations/$AUTOMATION_ID/runs"
> ```
>
> To install and sign in to the CLI, see [Call from the CLI](https://docs.coderabbit.ai/api/cli.md).

> [tab] MCP Server
>
> An agent connected to the [CodeRabbit MCP server](https://docs.coderabbit.ai/api/mcp.md) runs this operation as the `list_automation_runs` tool. The connection selects the organization, so the arguments have no `org_id` or `org_name`.
>
> ```json
> {
>   "method": "tools/call",
>   "params": {
>     "name": "list_automation_runs",
>     "arguments": {
>       "automation_id": "<automation_id>"
>     }
>   }
> }
> ```


## OpenAPI

````yaml /openapi.json get /v1/automations/{automation_id}/runs
openapi: 3.0.0
info:
  title: CodeRabbit API
  version: 1.0.0
  description: >-
    Read and manage CodeRabbit reviews, coding tasks, Verify, Triage, security
    findings, Knowledge Base, configuration, and users for your organization.
servers:
  - url: https://api.coderabbit.ai
    description: US region
  - url: https://api.eu.coderabbit.ai
    description: EU region
security:
  - ApiKeyAuth: []
tags:
  - name: Organizations and repositories
  - name: Pull requests and reviews
  - name: Coding Agent
  - name: Coding environments
  - name: Verify
  - name: Triage
  - name: Security
  - name: Knowledge Base
  - name: Automations
  - name: Reports
  - name: Configuration
  - name: Connections
  - name: Users and roles
  - name: Usage and metrics
paths:
  /v1/automations/{automation_id}/runs:
    get:
      tags:
        - Automations
      summary: List recorded ordinary Automation runs
      description: >-
        Pass next_offset as offset to continue. Run records retain the native
        execution evidence field names.
      operationId: list_automation_runs
      parameters:
        - name: automation_id
          in: path
          required: true
          schema:
            type: string
            minLength: 1
        - name: org_id
          in: query
          schema:
            type: string
            minLength: 1
            description: >-
              Organization for a workspace key: the Git-provider organization ID
              (scope.provider_organization_id) or the CodeRabbit organization ID
              (scope.id, or id from list organizations). Supply either org_id or
              org_name, never both. Omit for organization keys and MCP
              connections.
          allowEmptyValue: true
          allowReserved: true
        - name: org_name
          in: query
          schema:
            type: string
            pattern: ^[A-Za-z0-9][A-Za-z0-9-]{0,38}$
            description: >-
              GitHub organization login, such as coderabbitai, not its display
              name. Matched case-insensitively within the authenticated
              workspace. Supply either org_name or org_id, never both; omit for
              organization keys and MCP connections.
          allowEmptyValue: true
          allowReserved: true
        - name: message_platform_provider
          in: query
          schema:
            enum:
              - slack
              - discord
              - microsoft_teams
            type: string
            default: slack
          allowEmptyValue: true
          allowReserved: true
        - name: channel_id
          in: query
          schema:
            type: string
            minLength: 1
          allowEmptyValue: true
          allowReserved: true
        - name: offset
          in: query
          schema:
            type: integer
            minimum: 0
          allowEmptyValue: true
          allowReserved: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  active_runs:
                    type: array
                    items:
                      type: object
                      properties:
                        fireId:
                          type: string
                          minLength: 1
                        dispatchKind:
                          enum:
                            - scheduled_fire
                            - operation_continuation
                            - message_event_fire
                            - webhook_event_fire
                          type: string
                        status:
                          enum:
                            - scheduled
                            - running
                            - succeeded
                            - failed
                            - skipped
                          type: string
                        scheduledFor:
                          type: string
                          format: date-time
                        claimedAt:
                          type: string
                          format: date-time
                        startedAt:
                          type: string
                          format: date-time
                        completedAt:
                          type: string
                          format: date-time
                        workflowRunId:
                          type: string
                          minLength: 1
                        operationId:
                          type: string
                          minLength: 1
                        phaseId:
                          type: string
                          minLength: 1
                        continuationSeq:
                          type: integer
                          minimum: 0
                        threadKey:
                          type: string
                          minLength: 1
                        rootTs:
                          type: string
                          minLength: 1
                        channelId:
                          type: string
                          minLength: 1
                        runId:
                          type: string
                          minLength: 1
                        replyTs:
                          type: string
                          minLength: 1
                        resultSummary:
                          type: string
                          minLength: 1
                        lastError:
                          type: string
                          minLength: 1
                        openRunUrl:
                          type: string
                          format: uri
                        taskId:
                          type: string
                          minLength: 1
                          maxLength: 64
                        latestThinkingLines:
                          type: array
                          items:
                            type: string
                      required:
                        - fireId
                        - dispatchKind
                        - status
                        - scheduledFor
                  recent_runs:
                    type: array
                    items:
                      type: object
                      properties:
                        fireId:
                          type: string
                          minLength: 1
                        dispatchKind:
                          enum:
                            - scheduled_fire
                            - operation_continuation
                            - message_event_fire
                            - webhook_event_fire
                          type: string
                        status:
                          enum:
                            - scheduled
                            - running
                            - succeeded
                            - failed
                            - skipped
                          type: string
                        scheduledFor:
                          type: string
                          format: date-time
                        claimedAt:
                          type: string
                          format: date-time
                        startedAt:
                          type: string
                          format: date-time
                        completedAt:
                          type: string
                          format: date-time
                        workflowRunId:
                          type: string
                          minLength: 1
                        operationId:
                          type: string
                          minLength: 1
                        phaseId:
                          type: string
                          minLength: 1
                        continuationSeq:
                          type: integer
                          minimum: 0
                        threadKey:
                          type: string
                          minLength: 1
                        rootTs:
                          type: string
                          minLength: 1
                        channelId:
                          type: string
                          minLength: 1
                        runId:
                          type: string
                          minLength: 1
                        replyTs:
                          type: string
                          minLength: 1
                        resultSummary:
                          type: string
                          minLength: 1
                        lastError:
                          type: string
                          minLength: 1
                        openRunUrl:
                          type: string
                          format: uri
                        taskId:
                          type: string
                          minLength: 1
                          maxLength: 64
                        latestThinkingLines:
                          type: array
                          items:
                            type: string
                      required:
                        - fireId
                        - dispatchKind
                        - status
                        - scheduledFor
                  next_offset:
                    anyOf:
                      - type: integer
                        minimum: 0
                      - type: string
                        nullable: true
                        enum:
                          - null
                required:
                  - active_runs
                  - recent_runs
                  - next_offset
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        enum:
                          - invalid_request
                        type: string
                      message:
                        type: string
                      retry_after:
                        type: integer
                        minimum: 0
                        exclusiveMinimum: true
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        enum:
                          - unauthenticated
                        type: string
                      message:
                        type: string
                      retry_after:
                        type: integer
                        minimum: 0
                        exclusiveMinimum: true
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        enum:
                          - forbidden
                        type: string
                      message:
                        type: string
                      retry_after:
                        type: integer
                        minimum: 0
                        exclusiveMinimum: true
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
        '404':
          description: Not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        enum:
                          - not_found
                        type: string
                      message:
                        type: string
                      retry_after:
                        type: integer
                        minimum: 0
                        exclusiveMinimum: true
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        enum:
                          - head_changed
                          - conflict
                        type: string
                      message:
                        type: string
                      retry_after:
                        type: integer
                        minimum: 0
                        exclusiveMinimum: true
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
        '412':
          description: Precondition failed
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        enum:
                          - precondition_failed
                        type: string
                      message:
                        type: string
                      retry_after:
                        type: integer
                        minimum: 0
                        exclusiveMinimum: true
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
        '413':
          description: Content too large
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        enum:
                          - payload_too_large
                        type: string
                      message:
                        type: string
                      retry_after:
                        type: integer
                        minimum: 0
                        exclusiveMinimum: true
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
        '429':
          description: Too many requests
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        enum:
                          - rate_limit_exceeded
                        type: string
                      message:
                        type: string
                      retry_after:
                        type: integer
                        minimum: 0
                        exclusiveMinimum: true
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        enum:
                          - internal_error
                        type: string
                      message:
                        type: string
                      retry_after:
                        type: integer
                        minimum: 0
                        exclusiveMinimum: true
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
        '503':
          description: Service unavailable
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        enum:
                          - unavailable
                      message:
                        type: string
                      retry_after:
                        type: integer
                        minimum: 0
                        exclusiveMinimum: true
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-coderabbitai-api-key
      description: >-
        See [Authentication](/api/authentication) for the key types and where to
        create a key.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.