API Reference
API Modules for Test Management by Testsigma
Manage modules of test management like projects, folders, test cases, step groups, test runs, test plans & settings using APIs.
You can now use API Reference for Test Management by Testsigma to manage all modules of test management like projects, test cases, test runs, test plans, folders, step groups, and custom fields. These APIs support automation workflows and integration with CI/CD pipelines.
Each module includes a set of RESTful endpoints that support standard CRUD operations, status updates, and data retrieval. Authentication is managed via Bearer tokens, which must be included in each request.
Prerequisites
- Before you begin, ensure you have API Token from Test Management by Testsigma.
API Modules and Operations
Section titled “API Modules and Operations”| Module | Operation | Description |
|---|---|---|
| Projects | Get Project by ID | Retrieve details of a project by ID |
| Get List of Projects | List all projects with filters | |
| Create Project | Create a new project | |
| Update Project by ID | Update details of a specific project | |
| Delete Project by ID | Permanently delete a project | |
| Folders | Get Folder by ID | Fetch folder details by ID |
| List Folders | Get list of folders for a project | |
| Create Folder | Create a new folder within a project | |
| Move Folder by ID | Move folder under a parent folder | |
| Update Folder by ID | Rename or reorder an existing folder | |
| Delete Folder by ID | Delete a folder permanently | |
| Test Cases | Get Test Case by ID | Retrieve a specific test case |
| List Test Cases | View paginated list of test cases | |
| Create Test Case | Add a new test case to a project | |
| Update Test Case by ID | Modify an existing test case | |
| Delete Test Case by ID | Remove a test case permanently | |
| Step Groups | Get Step Group by ID | Fetch step group by ID |
| List Step Groups | List all step groups for a project | |
| Create Step Group | Create a reusable step group | |
| Update Step Group by ID | Modify an existing step group | |
| Delete Step Group by ID | Remove a step group | |
| Test Runs | Get Test Run by ID | View test run details by ID |
| List Test Runs | List all test runs under a project | |
| Get Test Run Cases by ID | View test cases under a specific test run | |
| Create Test Run | Create a new test execution run | |
| Update Test Run by ID | Update details of an existing test run | |
| Update Test Run Case Status | Update status for test cases within a run | |
| Assign User to Test Run Case | Assign a user to a test case in a run | |
| Delete Test Run by ID | Permanently remove a test run | |
| Report Imports | JUnit Report Import | Import JUnit test report into TMS |
| Get Import Status | Retrieve the status of an ongoing or past import | |
| Test Plans | Get Test Plan by ID | Retrieve a specific test plan |
| List Test Plans | List all test plans in a project | |
| List Test Runs for Test Plan | Get all test runs under a specific test plan | |
| Create Test Plan | Define and initiate a new test plan | |
| Complete Test Plan by ID | Mark a test plan as complete | |
| Update Test Plan by ID | Update an existing test plan | |
| Delete Test Plan by ID | Delete a test plan permanently | |
| Settings | Get Automation Types | Fetch automation strategy metadata |
| Get Test Case Types | Retrieve supported test case types | |
| Get Test Case Status | Fetch available test case statuses | |
| Get Test Case Priorities | Retrieve priority levels for test cases | |
| Get Test Run Status | View status values for test runs | |
| Get Users | List available users for assignment |