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

# List test runs

> Returns a paginated list of test runs for the scoped project, with optional filtering by id, branch, state, result, environment, and time window.

Test runs transition through these states:

| State        | Description                                                 |
| ------------ | ----------------------------------------------------------- |
| `pending`    | Run is queued behind other runs (concurrency limit reached) |
| `queued`     | Run is queued and will start soon                           |
| `started`    | Run is currently executing                                  |
| `ended`      | Run completed successfully                                  |
| `error`      | Run failed with an error                                    |
| `cancelling` | Run is being cancelled                                      |
| `cancelled`  | Run was cancelled                                           |

A failed run may carry one of these error codes:

| Error code              | Description                                          |
| ----------------------- | ---------------------------------------------------- |
| `merge_conflict`        | Merge conflict detected when merging the test branch |
| `dispatch_failed`       | Failed to dispatch the test run to workers           |
| `report_not_generated`  | Test report was not generated                        |
| `run_failed_with_error` | Test run failed with an error during execution       |
| `worker_interrupted`    | Test run worker was interrupted                      |
| `merge_reports_failed`  | Failed to merge sharded reports                      |


## OpenAPI

````yaml /api-reference/openapi.generated.json get /api/test-runs
openapi: 3.1.0
info:
  title: Empirical API
  version: 1.0.0
  description: Programmatic access to Empirical test runs, snoozes, and more.
  contact:
    name: Empirical
    url: https://empirical.run
servers:
  - url: https://api.empirical.run
security:
  - Bearer: []
tags:
  - name: Test Runs
    description: Trigger, list, and inspect end-to-end test runs.
  - name: Test Cases
    description: >-
      Browse the Playwright test cases synced from a project's repository and
      manage their tags.
  - name: Environments
    description: >-
      Named deployment targets (slug + Playwright project filters) a project's
      tests run against.
  - name: Snoozes
    description: Temporarily suppress known test failures for specific Playwright tests.
  - name: Analytics
    description: Aggregated test-run, test-count and test-case analytics for a project.
  - name: Resources
    description: >-
      Project file resources — uploads stored in R2 and external link-type files
      (e.g. Google Sheets).
  - name: Badges
    description: Public README status badge images (SVG) for project environments.
paths:
  /api/test-runs:
    get:
      tags:
        - Test Runs
      summary: List test runs
      description: >-
        Returns a paginated list of test runs for the scoped project, with
        optional filtering by id, branch, state, result, environment, and time
        window.
      operationId: listTestRuns
      parameters:
        - schema:
            type: integer
            minimum: 1
            description: Return only the test run with this exact ID.
          required: false
          description: Return only the test run with this exact ID.
          name: id
          in: query
        - schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 20
            description: Items per page (max 100). Defaults to 20.
          required: false
          description: Items per page (max 100). Defaults to 20.
          name: per_page
          in: query
        - schema:
            type: integer
            minimum: 1
            default: 1
            description: Page number (1-indexed). Defaults to 1.
          required: false
          description: Page number (1-indexed). Defaults to 1.
          name: page
          in: query
        - schema:
            type: string
            description: Filter to runs on this test repo branch.
          required: false
          description: Filter to runs on this test repo branch.
          name: branch
          in: query
        - schema:
            type: integer
            minimum: 1
            description: Restrict to runs created in the last N days.
          required: false
          description: Restrict to runs created in the last N days.
          name: interval_in_days
          in: query
        - schema:
            type: string
            description: Filter by run state (e.g. `queued`, `ended`).
          required: false
          description: Filter by run state (e.g. `queued`, `ended`).
          name: state
          in: query
        - schema:
            type: string
            enum:
              - passed
              - failed
            description: Filter by overall run result.
          required: false
          description: Filter by overall run result.
          name: result
          in: query
        - schema:
            type: string
            description: Comma-separated environment IDs to filter by.
          required: false
          description: Comma-separated environment IDs to filter by.
          name: environment_ids
          in: query
      responses:
        '200':
          description: Paginated list of test runs.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestRunsListResponse'
        '400':
          description: >-
            Invalid request, or the project could not be resolved from the
            request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Project not found or not accessible.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    TestRunsListResponse:
      type: object
      properties:
        data:
          type: object
          properties:
            project:
              type: object
              properties:
                id:
                  type: number
                  description: Project ID.
                name:
                  type: string
                  description: Project name.
                slug:
                  type: string
                  description: Project slug.
                repo_name:
                  type: string
                  description: Repository name for the project.
              required:
                - id
                - name
                - slug
                - repo_name
              description: The project the runs belong to.
            test_runs:
              type: object
              properties:
                items:
                  type: array
                  items:
                    $ref: '#/components/schemas/TestRunItem'
                  description: The page of test runs.
              required:
                - items
              description: Paginated test runs.
          required:
            - project
            - test_runs
        pagination:
          $ref: '#/components/schemas/Pagination'
      required:
        - data
        - pagination
    ErrorResponse:
      type: object
      properties:
        data:
          nullable: true
          description: Always null for error responses.
        error:
          type: object
          properties:
            message:
              type: string
              description: Human-readable error message.
          required:
            - message
          description: Error details.
      required:
        - data
        - error
    TestRunItem:
      type: object
      properties:
        id:
          type: number
          description: Unique identifier.
        state:
          type: string
          enum:
            - pending
            - queued
            - started
            - ended
            - error
            - cancelled
            - cancelling
          description: Current state of the test run.
        total_count:
          type: number
          description: Total number of test cases.
        success_count:
          type: number
          description: Number of passed tests.
        failed_count:
          type: number
          description: Number of failed tests.
        skipped_count:
          type: number
          nullable: true
          description: Number of skipped tests.
        flaky_count:
          type: number
          nullable: true
          description: Number of flaky tests.
        duration:
          type: number
          nullable: true
          description: Duration in milliseconds.
        test_run_branch:
          type: string
          nullable: true
          description: Git branch being tested.
        environment_slug:
          type: string
          nullable: true
          description: Environment identifier.
        environment_name:
          type: string
          nullable: true
          description: Environment display name.
        build_url:
          type: string
          nullable: true
          description: URL of the build being tested.
        build_branch:
          type: string
          nullable: true
          description: Git branch of the build.
        commit:
          type: string
          nullable: true
          description: Commit SHA.
        created_at:
          type: string
          description: ISO 8601 timestamp.
      required:
        - id
        - state
        - total_count
        - success_count
        - failed_count
        - skipped_count
        - flaky_count
        - duration
        - test_run_branch
        - environment_slug
        - environment_name
        - build_url
        - build_branch
        - commit
        - created_at
    Pagination:
      type: object
      properties:
        page:
          type: integer
          description: Current page (1-indexed).
        per_page:
          type: integer
          description: Items per page.
        total:
          type: integer
          description: Total number of items.
        total_pages:
          type: integer
          description: Total number of pages.
      required:
        - page
        - per_page
        - total
        - total_pages
      description: Pagination metadata.
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer

````