Skip to main content
GET
Get test case

Path Parameters

id
string
required

Query Parameters

query
object
required

Response

200 - application/json

The request has succeeded.

A test case's authored configuration — what the agent is instructed to do — as distinct from a run's result (see get_run_test_case).

id
string
required

Project test case ID (UUID). Works with update_test_case, start_run_with_test_cases (testCaseIds), and rerun_run (projectTestCaseIds).

name
string
required
isEnabled
boolean
required
labels
string[]
required
classification
enum<string>
required

POSITIVE (expected to succeed) or NEGATIVE (expected to fail).

Available options:
POSITIVE,
NEGATIVE
applicationShortId
string
required
Pattern: ^app(-.+_.+|_.+)$
applicationName
string
required
scenarioShortId
string | null
required

Scenario (folder grouping related test cases) the test belongs to. null when ungrouped.

Pattern: ^scenario(-.+_.+|_.+)$
scenarioName
string | null
required
goal
string | null
required

The test's goal — what the agent tries to achieve.

expectedResult
string | null
required

The expected result / success criteria the evaluator checks against.

steps
string[]
required

Authored step instructions, in order. Empty when the test only has a goal.

startUrlPath
string | null
required

URL path the agent navigates to before executing (e.g. /dashboard). null means the test starts from its RESUME_FROM dependency's end state, or the application's base URL when it has no dependency.

resumeFromDependencyProjectTestCaseId
string | null
required

Test case whose output state this test resumes from (RESUME_FROM). null when the test starts fresh.

waitForDependenciesProjectTestCaseIds
string[]
required

Test cases that must finish before this one runs (WAIT_FOR — ordering only, no state carry-over).

createdAt
string
required
updatedAt
string | null
required
url
string
required

Deep link to edit the test case in the QA.tech UI.