Get a test plan
GET
/projects/{project_id}/test_plans/{test_plan_id}Base URL
https://arcus.testsigma.com/api/v1Retrieves the details of a specific test plan by its unique identifier.
Authenticate with your API key as a
Bearer token in the Authorization header. How to authenticate →Path parameters
project_id | Unique identifier of the project that contains the test plan. |
test_plan_id | Unique identifier or human-readable ID of the test plan to retrieve. |
Response attributes
message | Status message for the request. |
data.test_plan.id | Unique identifier of the test plan. |
data.test_plan.human_id | Human-readable identifier of the test plan. |
data.test_plan.title | Title of the test plan. |
data.test_plan.description | Description of the test plan. Left out when empty. |
data.test_plan.status | ACTIVE or COMPLETED. |
data.test_plan.start_date | Start date of the test plan as a Unix timestamp in milliseconds. 0 when not set. |
data.test_plan.end_date | End date of the test plan as a Unix timestamp in milliseconds. 0 when not set. |
data.test_plan.completed_at | Unix timestamp, in milliseconds, of when the test plan was completed. Left out until then. |
data.test_plan.completed_by | ID of the user who completed the test plan. Left out until then. |
data.test_plan.project_id | Unique identifier of the project. |
data.test_plan.labels | Labels on the test plan, each with id, name, createdAt, and updatedAt. Left out when there are none. |
data.test_plan.environment_id | Environment the plan's runs use. Null means the project default. |
data.test_plan.test_runs_count | Number of test runs in the test plan. |
data.test_plan.test_cases_count | Number of test cases in the test plan. |
data.test_plan.created_at | Unix timestamp, in milliseconds, of when the test plan was created. |
data.test_plan.updated_at | Unix timestamp, in milliseconds, of the last update to the test plan. |
data.run_templates | Recurring plans only. The plan's run templates, each with run_template_id, human_id, title, execution_type, and the run_configurations a cycle runs it on. |
Request
curl -X GET \
'https://arcus.testsigma.com/api/v1/projects/{project_id}/test_plans/{test_plan_id}' \
-H 'Authorization: Bearer <API_KEY>' \
-H 'Content-Type: application/json'const response = await fetch('https://arcus.testsigma.com/api/v1/projects/{project_id}/test_plans/{test_plan_id}', {
method: 'GET',
headers: {
'Authorization': 'Bearer <API_KEY>',
'Content-Type': 'application/json'
}
});
const data = await response.json();import requests
response = requests.get(
'https://arcus.testsigma.com/api/v1/projects/{project_id}/test_plans/{test_plan_id}',
headers={
'Authorization': 'Bearer <API_KEY>',
'Content-Type': 'application/json'
}
)
data = response.json()Response200 OK
{
"message": "Test plan fetched successfully",
"data": {
"test_plan": {
"id": "f2a8c1d4-9e63-4b27-8a51-7c0d6e9f3b42",
"human_id": "HCP-P-1",
"title": "Patient Portal Regression",
"description": "Full regression cycle for the Q2 patient portal release.",
"status": "ACTIVE",
"start_date": 1710374400000,
"end_date": 1712966400000,
"project_id": "bd57bbc6-e83e-4f09-927d-fc48b3509cdf",
"labels": [
{
"id": "3ebf1ec4-f994-4f41-822a-01305e1f78c1",
"name": "regression",
"createdAt": 1710370000000,
"updatedAt": 1710370000000
}
],
"environment_id": null,
"test_runs_count": 1,
"test_cases_count": 42,
"created_at": 1710370000000,
"updated_at": 1710716800000
},
"run_templates": [
{
"run_template_id": "6f1c4b2a-8d3e-4f5a-9b6c-7d8e9f0a1b2c",
"human_id": "HCP-R-14",
"title": "Checkout flows",
"execution_type": "AUTOMATED",
"run_configurations": [
{
"id": "3e7a9b1c-2d4f-4a6b-8c0d-1e2f3a4b5c6d",
"name": "Chrome on Windows",
"provider": "MANAGED_LAB",
"application_type": "WEB_APPLICATION",
"platform": "windows-11",
"browser": "chrome-130",
"device_model": null,
"resolution": "1920x1080"
}
]
}
]
}
}Was this page helpful?
Thanks for the feedback.