Skip to main content
GET
Permission Required: project:read-runs
Retrieve a specific test plan by ID, including its test items.

Response

id
string
required
Unique identifier for the test plan
project_id
string
required
Project the test plan belongs to
name
string
required
Test plan name
created_at
string
ISO 8601 timestamp when the test plan was created
created_by
string
Who created the test plan
modified_at
string
ISO 8601 timestamp when the test plan was last modified
modified_by
string
Who last modified the test plan
slots
Slot[]
required
Extra deployment slots of a cross-platform test plan (empty for regular plans). Slots are read-only via the API and managed in the test plan editor; their indices key slot_deployment_configs on Start Test Plan Run.
default_slot_name
string
Optional display name of the implicit default slot (slot 1)
test_items
TestItem[]
required
Ordered list of tests in this plan

Authorizations

X-Api-Key
string
header
required

API key for authentication

Path Parameters

testPlanId
string<uuid>
required

The test plan ID (UUID)

projectId
string
required

The project ID. You can copy it from the project settings page or the project URL in the dashboard.

Response

Successful response

id
string<uuid>

Unique identifier for the test plan

project_id
string<uuid>

Project the test plan belongs to

name
string

Test plan name

created_at
string<date-time> | null
created_by
string | null
modified_at
string<date-time> | null
modified_by
string | null
slots
object[]

Extra deployment slots of a cross-platform test plan (read-only via the API; managed in the test plan editor). Their indices key slot_deployment_configs when starting the plan; slot 1 is the implicit default slot.

default_slot_name
string | null

Optional display name of the implicit default slot (slot 1). Read-only via the API.

test_items
object[]

Ordered list of tests in this plan