> ## 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.



## OpenAPI

````yaml /openapi.json get /v1/automations/{automation_id}/runs
openapi: 3.0.3
info:
  title: CodeRabbit API spec
  version: 1.0.0
servers:
  - url: https://api.coderabbit.ai
security:
  - ApiKeyAuth: []
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: >-
              Git-provider organization ID. Required for workspace keys; omit
              for organization keys. This differs from the CodeRabbit
              organization ID in scope.id.
          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
            maximum: 9007199254740991
          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
                          maximum: 9007199254740991
                        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
                          maximum: 9007199254740991
                        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
                        maximum: 9007199254740991
                      - type: string
                        nullable: true
                        enum:
                          - null
                required:
                  - active_runs
                  - recent_runs
                  - next_offset
        '400':
          description: '400'
          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
                        maximum: 9007199254740991
                        exclusiveMinimum: true
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
        '401':
          description: '401'
          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
                        maximum: 9007199254740991
                        exclusiveMinimum: true
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
        '403':
          description: '403'
          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
                        maximum: 9007199254740991
                        exclusiveMinimum: true
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
        '404':
          description: '404'
          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
                        maximum: 9007199254740991
                        exclusiveMinimum: true
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
        '409':
          description: '409'
          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
                        maximum: 9007199254740991
                        exclusiveMinimum: true
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
        '412':
          description: '412'
          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
                        maximum: 9007199254740991
                        exclusiveMinimum: true
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
        '413':
          description: '413'
          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
                        maximum: 9007199254740991
                        exclusiveMinimum: true
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
        '429':
          description: '429'
          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
                        maximum: 9007199254740991
                        exclusiveMinimum: true
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
        '500':
          description: '500'
          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
                        maximum: 9007199254740991
                        exclusiveMinimum: true
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
        '503':
          description: '503'
          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
                        maximum: 9007199254740991
                        exclusiveMinimum: true
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-coderabbitai-api-key
      description: >-
        API key for authentication. You can create an API key from the
        CodeRabbit dashboard.

````

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