Get a test plan

GET/projects/:project_id/test_plans/:test_plan_id

Base URL https://test-management.testsigma.com/api/v1

Retrieves the details of a specific test plan by its unique identifier.

Authenticate with your API key as a Bearer token in the Authorization header. Generate a key →

PATH PARAMETERS

`project_id`	Unique identifier of the project that contains the test plan.
`test_plan_id`	Unique identifier of the test plan to retrieve.

RESPONSE ATTRIBUTES

`message`	Status message for the request; may be empty.
`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.
`data.test_plan.status`	Current status of the test plan.
`data.test_plan.start_date`	Start date of the test plan as a Unix timestamp.
`data.test_plan.end_date`	End date of the test plan as a Unix timestamp.
`data.test_plan.created_at`	Unix timestamp of when the test plan was created.
`data.test_plan.updated_at`	Unix timestamp of the last update to the test plan.

REQUEST

curl -X GET \
  'https://test-management.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://test-management.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://test-management.testsigma.com/api/v1/projects/:project_id/test_plans/:test_plan_id',
  headers={
    'Authorization': 'Bearer <API_KEY>',
    'Content-Type': 'application/json'
  }
)
data = response.json()

RESPONSE200OK

{
  "message": "",
  "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": 1710374400,
      "end_date": 1712966400,
      "created_at": 1710370000,
      "updated_at": 1710716800
    }
  }
}