Zephyr: Get Folders
zephyr_get_foldersRetrieve Zephyr folders by project and type to browse test case, plan, or cycle structures.
Instructions
Get folders, optionally filtered by project and folder type
Toolset: Folders
Parameters:
maxResults (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 maxResults value in the response to confirm how many results were actually returned. (default: 10)
startAt (number): Zero-indexed starting position. Should be a multiple of maxResults. (default: 0)
projectKey (string): Jira project key filter
folderType (string): Folder type filter. Either
"TEST_CASE","TEST_PLAN"or"TEST_CYCLE"
Use Cases: 1. List folders in a Zephyr project 2. Get Test Case folders for a project 3. Get Test Plan folders for a project 4. Get Test Cycle folders for a project 5. Browse the folder structure in Zephyr
Examples:
Get the first 10 Folders
{
"maxResults": 10,
"startAt": 0
}Expected Output: The first 10 Folders with their details
Get Folders from the project SA
{
"projectKey": "SA",
"maxResults": 10,
"startAt": 0
}Expected Output: Folders belonging to project SA with their details
Get Test Case Folders from the project MM2
{
"projectKey": "MM2",
"folderType": "TEST_CASE",
"maxResults": 10,
"startAt": 0
}Expected Output: Test Case Folders belonging to project MM2 with their details
Get Test Cycle Folders across all projects
{
"folderType": "TEST_CYCLE",
"maxResults": 10,
"startAt": 0
}Expected Output: Test Cycle Folders from all projects with their details
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| startAt | No | Zero-indexed starting position. Should be a multiple of maxResults. | |
| folderType | No | Folder type filter. Either `"TEST_CASE"`, `"TEST_PLAN"` or `"TEST_CYCLE"` | |
| maxResults | 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 maxResults value in the response to confirm how many results were actually returned. | |
| projectKey | No | Jira project key filter |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| next | No | URL to the next page of results, or null if there are no more results. | |
| total | No | Indicates the total number of items available across all pages. | |
| isLast | No | Indicates if this is the last page of results. | |
| values | No | ||
| startAt | Yes | Indicates the index of the first item returned in the page of results. | |
| maxResults | Yes | Indicates the maximum number of results in this response. Note that the server may enforce a lower limit than requested, depending on resource availability or other internal constraints. |