Skip to content
Testsigma DOCS
Login Book a demo

List test cases

GET/projects/:project_id/test_cases

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

Retrieve a paginated list of test cases associated with a specific project.

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

PATH PARAMETERS

project_idUnique identifier of the project whose test cases are being requested.

QUERY PARAMETERS

page_sizeNumber of test cases to return per page.

RESPONSE ATTRIBUTES

messageA message that may contain additional information about the response; empty if no message.
data.test_cases[].idUnique identifier for the test case.
data.test_cases[].titleThe title of the test case.
data.test_cases[].descriptionA detailed description of the test case.
data.test_cases[].template_typeThe type of template used for the test case.
data.test_cases[].human_idHuman-readable identifier for the test case.
data.test_cases[].owner_idIdentifier of the user who owns the test case.
data.test_cases[].type_idThe type identifier of the test case.
data.test_cases[].status_idThe current status identifier of the test case.
data.test_cases[].automation_type_idIdentifier for the type of automation applied.
data.test_cases[].priority_idThe priority level identifier of the test case.
data.test_cases[].folder_idIdentifier of the folder containing the test case.
data.test_cases[].project_idIdentifier of the project to which the test case belongs.
data.test_cases[].individual_steps[].idUnique identifier for the step.
data.test_cases[].individual_steps[].step_descriptionA description of the step.
data.test_cases[].individual_steps[].expected_resultsThe expected outcome of the step.
data.test_cases[].individual_steps[].orderThe order in which the step should be executed.
data.test_cases[].individual_steps[].step_typeThe type of the step.
data.test_cases[].individual_steps[].test_case_idIdentifier of the test case this step belongs to.
data.test_cases[].individual_steps[].created_atTimestamp when the step was created.
data.test_cases[].individual_steps[].updated_atTimestamp when the step was last updated.
page_info.page_sizeThe number of test cases returned in the response.
page_info.total_countThe total number of test cases available for the project.
page_info.nextA link to the next page of results, if applicable.
page_info.prevA link to the previous page of results, if applicable.
REQUEST
curl -X GET \
  'https://test-management.testsigma.com/api/v1/projects/:project_id/test_cases' \
  -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_cases', {
  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_cases',
  headers={
    'Authorization': 'Bearer <API_KEY>',
    'Content-Type': 'application/json'
  }
)
data = response.json()
RESPONSE200OK
{
  "message": "",
  "data": {
    "test_cases": [
      {
        "id": "9c09349f-5c16-4d29-9f8e-194576b6b841",
        "title": "Attempt to book a flight with missing required fields",
        "description": "Attempt to book a flight with missing required fields",
        "template_type": "TCD",
        "human_id": "DEMO-2",
        "owner_id": "cbbc40a5-26e9-4b88-8c27-3626c9fbdaa4",
        "type_id": "75a816d1-8909-47b5-b85b-fbf60a973587",
        "status_id": "bafd7f8d-832a-42ea-91df-9a1e5e02a2d9",
        "automation_type_id": "3cee45b5-4335-4564-bbdf-4ea9b0306ed3",
        "priority_id": "1d810f8f-7be0-41e4-9971-67ee1f55612e",
        "folder_id": "580e3972-7f4a-4748-87e6-9b74873e2b93",
        "project_id": "c47ade67-0543-4582-a4a5-b7de447c94f5",
        "individual_steps": [
          {
            "id": "a1f2c3d4-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
            "step_description": "Navigate to the flight booking page",
            "expected_results": "The booking page is displayed",
            "order": 1,
            "step_type": "DEFAULT",
            "test_case_id": "9c09349f-5c16-4d29-9f8e-194576b6b841",
            "created_at": 1710675200,
            "updated_at": 1710675200
          }
        ]
      },
      {
        "id": "d07c9975-afd5-4874-93e2-2186ec3efa47",
        "title": "Verify successful flight booking with valid details",
        "description": "Book a flight with all required fields populated correctly",
        "template_type": "STEPS",
        "human_id": "DEMO-3",
        "owner_id": "cbbc40a5-26e9-4b88-8c27-3626c9fbdaa4",
        "type_id": "75a816d1-8909-47b5-b85b-fbf60a973587",
        "status_id": "bafd7f8d-832a-42ea-91df-9a1e5e02a2d9",
        "automation_type_id": "3cee45b5-4335-4564-bbdf-4ea9b0306ed3",
        "priority_id": "1d810f8f-7be0-41e4-9971-67ee1f55612e",
        "folder_id": "580e3972-7f4a-4748-87e6-9b74873e2b93",
        "project_id": "c47ade67-0543-4582-a4a5-b7de447c94f5",
        "individual_steps": [
          {
            "id": "b2e3d4c5-6f7a-4b8c-9d0e-1f2a3b4c5d6e",
            "step_description": "Enter all required passenger details",
            "expected_results": "Passenger details are accepted",
            "order": 1,
            "step_type": "DEFAULT",
            "test_case_id": "d07c9975-afd5-4874-93e2-2186ec3efa47",
            "created_at": 1710678800,
            "updated_at": 1710678800
          }
        ]
      }
    ]
  },
  "page_info": {
    "page_size": 25,
    "total_count": 2,
    "next": "",
    "prev": ""
  }
}