Skip to content
Testsigma DOCS

Get test suites

GET/test_suites

Base URL  https://app.testsigma.com/api/v1

Retrieve all test suites in the project with their last run status.

Authenticate with your API key as a Bearer token in the Authorization header. Generate a key →
idUnique test suite identifier.
nameName of the test suite.
descriptionDescription of what the suite covers.
appVersionIdID of the application version this suite belongs to.
preRequisiteID of a prerequisite test suite, if any.
lastRun.resultResult of the latest run — PASSED, FAILURE, ABORTED, etc.
lastRun.totalCountTotal number of test cases in the last run.
lastRun.passedCountNumber of test cases that passed.
lastRun.failedCountNumber of test cases that failed.
createdByIdID of the user who created the suite.
REQUEST
curl -X GET \
  'https://app.testsigma.com/api/v1/test_suites' \
  -H 'Authorization: Bearer <API_KEY>' \
  -H 'Content-Type: application/json'
const response = await fetch('https://app.testsigma.com/api/v1/test_suites', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer <API_KEY>',
    'Content-Type': 'application/json'
  }
});
const data = await response.json();
import requests

response = requests.get(
  'https://app.testsigma.com/api/v1/test_suites',
  headers={
    'Authorization': 'Bearer <API_KEY>',
    'Content-Type': 'application/json'
  }
)
data = response.json()
RESPONSE200OK
{
  "content": [
    {
      "id": 84,
      "name": "Home Page Tests",
      "description": "Smoke tests for the home page",
      "appVersionId": 39,
      "preRequisite": null,
      "createdById": 9,
      "createdDate": 1567753941000,
      "lastRun": {
        "id": 951,
        "result": "PASSED",
        "status": "STATUS_COMPLETED",
        "totalCount": 8,
        "passedCount": 8,
        "failedCount": 0,
        "startTime": 1657912101000,
        "endTime": 1657912630000
      }
    },
    {
      "id": 85,
      "name": "Checkout Flow",
      "description": "End-to-end checkout tests",
      "appVersionId": 39,
      "createdById": 9,
      "createdDate": 1570000000000,
      "lastRun": {
        "id": 952,
        "result": "FAILURE",
        "status": "STATUS_COMPLETED",
        "totalCount": 5,
        "passedCount": 3,
        "failedCount": 2
      }
    }
  ],
  "totalElements": 2,
  "totalPages": 1
}