getCases
Retrieve a list of test cases with basic fields from a TestRail project and suite. Filter by creator, priority, milestone, and more to find specific cases.
Instructions
Retrieves test cases list with basic fields only (excludes steps/expected results for performance). REQUIRED: projectId, suiteId. OPTIONAL: createdBy, filter, limit (default 50), milestoneId, offset (default 0), priorityId, refs, sectionId, templateId, typeId, updatedBy, labelId. Use getCase for full details.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| projectId | Yes | TestRail Project ID | |
| suiteId | Yes | TestRail Suite ID | |
| createdBy | No | A comma-separated list of creators (user IDs) to filter by | |
| filter | No | Only return cases with matching filter string in the case title | |
| limit | No | The number of test cases the response should return (The response size is 50 by default) —requires TestRail 6.7 or later | |
| milestoneId | No | A comma-separated list of milestone IDs to filter by (not available if the milestone field is disabled for the project) | |
| offset | No | Where to start counting the tests cases from (the offset)—requires TestRail 6.7 or later | |
| priorityId | No | A comma-separated list of priority IDs to filter by | |
| refs | No | A single Reference ID (e.g. TR-1, 4291, etc.) —requires TestRail 6.5.2 or later | |
| sectionId | No | The ID of a test case section | |
| templateId | No | A comma-separated list of template IDs to filter by —requires TestRail 5.2 or later | |
| typeId | No | A comma-separated list of case type IDs to filter by | |
| updatedBy | No | A comma-separated list of user IDs who updated test cases to filter by | |
| labelId | No | A comma-separated list of label IDs to filter by |