Skip to main content
GET
Permission Required: project:read-runs
Retrieve a paginated list of test plans for your project.

Query Parameters

Search by test plan name
sort_by
string
default:"name"
Field to sort by: name, test_count, modified_at, or created_at
sort_order
string
default:"asc"
Sort direction: asc or desc
page
integer
default:"0"
Page number (0-indexed)
page_size
integer
default:"20"
Results per page (1-100)

Response

data
TestPlanSummary[]
required
Array of test plan summary objects
pagination
object
required
Pagination information

TestPlanSummary Object

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
test_count
integer
required
Number of tests in the plan
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

Authorizations

X-Api-Key
string
header
required

API key for authentication

Path Parameters

projectId
string
required

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

Query Parameters

Search by test plan name

sort_by
enum<string>
default:name

Field to sort by

Available options:
name,
test_count,
modified_at,
created_at
sort_order
enum<string>
default:asc

Sort direction

Available options:
asc,
desc
page
integer
default:0

Page number (0-indexed)

page_size
integer
default:20

Results per page (1-100)

Required range: 1 <= x <= 100

Response

Successful response

data
object[]
pagination
object