List test plans

GET/projects/:project_id/test_plans

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

Retrieves a paginated list of test plans for a specific project.

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 whose test plans are listed.

QUERY PARAMETERS

`page_size`	Number of test plans to return per page.
`name__NEQ`	Excludes test plans whose name matches the given value.

RESPONSE ATTRIBUTES

`message`	Status message for the request; may be empty.
`data.test_plans[].id`	Unique identifier of the test plan.
`data.test_plans[].human_id`	Human-readable identifier of the test plan.
`data.test_plans[].name`	Name of the test plan.
`data.test_plans[].description`	Description of the test plan.
`data.test_plans[].status`	Current status of the test plan.
`data.test_plans[].created_at`	Unix timestamp of when the test plan was created.
`data.test_plans[].updated_at`	Unix timestamp of the last update to the test plan.
`page_info.page_size`	Number of items returned per page.
`page_info.total_count`	Total number of test plans available.
`page_info.next`	URL to the next page of results, if any.
`page_info.prev`	URL to the previous page of results, if any.

REQUEST

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

RESPONSE200OK

{
  "message": "",
  "data": {
    "test_plans": [
      {
        "id": "f2a8c1d4-9e63-4b27-8a51-7c0d6e9f3b42",
        "human_id": "HCP-P-1",
        "name": "Patient Portal Regression",
        "description": "Full regression cycle for the Q2 patient portal release.",
        "status": "ACTIVE",
        "created_at": 1710370000,
        "updated_at": 1710716800
      },
      {
        "id": "6b9d0e72-3f15-4c88-a204-8e1f5a7c2d90",
        "human_id": "HCP-P-2",
        "name": "Smoke Suite Nightly",
        "description": "Nightly smoke checks for critical patient workflows.",
        "status": "COMPLETED",
        "created_at": 1709452800,
        "updated_at": 1710115200
      }
    ]
  },
  "page_info": {
    "page_size": 2,
    "total_count": 9,
    "next": "https://test-management.testsigma.com/api/v1/projects/bd57bbc6-e83e-4f09-927d-fc48b3509cdf/test_plans?page_size=2&page=2",
    "prev": ""
  }
}