Zephyr: Get Test Cases
zephyr_get_test_casesRetrieve test case details from Zephyr using filters like project key, folder ID, and update time. Supports pagination and returns up to 1000 results.
Instructions
Get details of test cases in Zephyr
Toolset: Test Cases
Parameters:
projectKey (string): Jira project key filter
folderId (number): Folder ID filter
limit (number): Specifies the maximum number of results to return in a single call. The default value is 10, and the maximum value that can be requested is 1000.
Note that the server may enforce a lower limit than requested, depending on resource availability or other internal constraints. If this happens, the result set may be truncated. Always check the limit value in the response to confirm how many results were actually returned. (default: 10)
startAtId (number): Zero-indexed starting position for ID-based pagination. (default: 0)
updatedAfter (string): Filter only entities updated after the given time. Format: yyyy-MM-dd'T'HH:mm:ss'Z'
Examples:
Get the first 10 Test Cases
{
"limit": 10,
"startAtId": 1
}Expected Output: The first 10 Test Cases with their details
Get any Test Case
{
"limit": 1
}Expected Output: One Test Case with its details
Get five Test Cases starting from the ID 123
{
"limit": 5,
"startAtId": 123
}Expected Output: Five Test Cases starting from the ID 123 with their details
Get one Test Case from the project PROJ
{
"projectKey": "PROJ",
"limit": 1
}Expected Output: One Test Case from project PROJ with its details
Get one Test Case from the folder with ID 123
{
"folderId": 123,
"limit": 1
}Expected Output: One Test Case from folder with ID 123 with its details
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Specifies the maximum number of results to return in a single call. The default value is 10, and the maximum value that can be requested is 1000. Note that the server may enforce a lower limit than requested, depending on resource availability or other internal constraints. If this happens, the result set may be truncated. Always check the limit value in the response to confirm how many results were actually returned. | |
| folderId | No | Folder ID filter | |
| startAtId | No | Zero-indexed starting position for ID-based pagination. | |
| projectKey | No | Jira project key filter | |
| updatedAfter | No | Filter only entities updated after the given time. Format: yyyy-MM-dd'T'HH:mm:ss'Z' |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| next | No | ||
| limit | Yes | ||
| values | No | ||
| nextStartAtId | Yes |