Get test suites

GET/test_suites

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

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. How to authenticate →

Response attributes

`id`	Unique test suite identifier.
`name`	Name of the test suite.
`description`	Description of what the suite covers.
`appVersionId`	ID of the application version this suite belongs to.
`preRequisite`	ID of a prerequisite test suite, if any.
`lastRun.result`	Result of the latest run — PASSED, FAILURE, ABORTED, etc.
`lastRun.totalCount`	Total number of test cases in the last run.
`lastRun.passedCount`	Number of test cases that passed.
`lastRun.failedCount`	Number of test cases that failed.
`createdById`	ID 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()

Response200 OK

{
  "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
}

Was this page helpful?