List Test Cases
list_test_casesRetrieves a project's test cases with filters so you can discover test case keys before recording results with add_test_run_results.
Instructions
Retrieves list of test cases of a project with support for various filters.
Use this to discover the test case keys a project actually contains before recording results against them with add_test_run_results.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | controls number of records in output, every page contains 100 records. Default is 1. | |
| filter_key | No | to filter test cases with key containing the specified value | |
| filter_name | No | to filter test cases with name containing the specified value | |
| filter_project | Yes | specifies the project ID to filter the test cases associated with a particular project | |
| filter_test_suite | No | ID of the test suite to filter the test cases by. Only the ID works: a suite's key or name returns zero rows, not an error. Find suite IDs with list_test_suites. | |
| filter_custom_fields | No | maps a custom field's key to the value to filter on, e.g. {'priority_band': '<option-id>'}. The field key is whatever the tenant named it, so any project's own field set can be filtered here. Only fields applicable to test cases can be filtered; a field scoped to test run results is not reachable through this endpoint. Verified live by field type: dropdown: pass the option's ID, not its displayed label. Read the ID off any case that already has the field set, where it is returned inline as customFields.<field>.id. checkbox: pass a bool or the lowercase string 'true'/'false'. A bool is normalised to the lowercase form Tuskr expects. text: matches on substring, not equality. steps: NOT filterable. Tuskr accepts the parameter and returns every case in the project unfiltered. Numbers and multi-select remain unverified. Tuskr ignores a filter it does not understand instead of rejecting it, so a filter that fails to narrow the results means the field type or value shape is unsupported, not that nothing matched. | |
| filter_test_case_type | No | ID of the test case type to filter by. Read the ID off the testCaseTypeId field of any case row. Only the ID form is verified; a type's displayed name is untested as a filter value. Verified live: a valid ID narrows the result set, and an unknown value returns zero rows rather than an error or the unfiltered set, so an empty result can mean a mistyped ID, not that no case has that type. | |
| filter_test_suite_section | No | ID of the test suite section to filter the test cases by. Only the ID works: a section name returns zero rows. Find section IDs with list_test_suites. |