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

# Get test plan

> Fetch a test plan with the test cases it contains



## OpenAPI

````yaml /api-reference/api.json get /v1/test-plans/{testPlanShortId}
openapi: 3.0.0
info:
  title: QA.tech API
  version: 1.0.0
  contact:
    name: QA.tech
    url: https://qa.tech
    email: support@qa.tech
  description: API for triggering and managing AI-powered test runs
servers:
  - url: https://api.qa.tech
    description: Production
    variables: {}
security:
  - BearerAuth: []
tags:
  - name: Runs
  - name: Infrastructure
  - name: Test Cases
  - name: Application Builds
  - name: Status badge
  - name: Remote Tunnels
  - name: Chat
  - name: Applications
  - name: Features
  - name: Metrics
  - name: Projects
  - name: Knowledge
  - name: Rules
  - name: Labels
  - name: Issues
  - name: Todos
  - name: Automations
  - name: Test plans
paths:
  /v1/test-plans/{testPlanShortId}:
    get:
      tags:
        - Test plans
      summary: Get test plan
      description: Fetch a test plan with the test cases it contains
      operationId: GetTestPlan
      parameters:
        - name: testPlanShortId
          in: path
          required: true
          schema:
            type: string
        - name: query
          in: query
          required: true
          schema:
            $ref: '#/components/schemas/ProjectScopedRequest'
          explode: false
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetTestPlanResponse'
components:
  schemas:
    ProjectScopedRequest:
      type: object
      properties:
        projectShortId:
          allOf:
            - $ref: '#/components/schemas/ProjectShortId'
          description: >-
            Target a specific project by its prefixed short ID
            (proj-slug_shortId or proj_shortId), as returned by the projects
            API. Required for organization-scoped API keys; project-scoped keys
            may only pass their own project's short ID.
      description: >-
        Mixin for project-scoped requests: an optional per-call project
        override.
    GetTestPlanResponse:
      type: object
      required:
        - testPlan
      properties:
        testPlan:
          $ref: '#/components/schemas/TestPlanDetail'
    ProjectShortId:
      type: string
      pattern: ^proj(-.+_.+|_.+)$
    TestPlanDetail:
      type: object
      required:
        - shortId
        - name
        - description
        - testCaseCount
        - createdAt
        - updatedAt
        - reviewInstructions
        - testCases
      properties:
        shortId:
          allOf:
            - $ref: '#/components/schemas/TestPlanShortId'
          description: >-
            Prefixed short ID in the form `pln-<name-slug>_<id>`, for example
            `pln-smoke_abc123`; the bare `pln_<id>` form is accepted too. Pass
            it unchanged as `testPlanShortId` to `start_run_with_test_plan` or
            to the `testPlanShortId` filter on `list_runs`.
        name:
          type: string
        description:
          type: string
        testCaseCount:
          type: integer
          format: int32
          description: Number of published test cases in the plan
        createdAt:
          type: string
        updatedAt:
          type: string
          nullable: true
        reviewInstructions:
          type: string
          nullable: true
          description: >-
            Guidance given to the PR review agent when this plan is used for PR
            checks
        testCases:
          type: array
          items:
            $ref: '#/components/schemas/TestPlanTestCase'
    TestPlanShortId:
      type: string
      pattern: ^pln(-.+_.+|_.+)$
    TestPlanTestCase:
      type: object
      required:
        - id
        - name
        - isEnabled
        - applicationShortId
      properties:
        id:
          type: string
          description: >-
            Project test case ID (UUID), as used by `get_test_case` and
            `start_run_with_test_cases`
        name:
          type: string
        isEnabled:
          type: boolean
        applicationShortId:
          $ref: '#/components/schemas/ApplicationShortId'
    ApplicationShortId:
      type: string
      pattern: ^app(-.+_.+|_.+)$
  securitySchemes:
    BearerAuth:
      type: http
      scheme: Bearer

````

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