Zephyr: Get Projects
zephyr_get_projectsRetrieve Zephyr project details with paginated results. Use maxResults and startAt parameters to fetch specific project subsets.
Instructions
Get details of projects in Zephyr
Toolset: Projects
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)
Examples:
Get the first 10 projects
{
"maxResults": 10,
"startAt": 0
}Expected Output: The first 10 projects with their details
Get any project
{
"maxResults": 1
}Expected Output: One project with its details
Get five projects starting from the 7th project of the list
{
"maxResults": 5,
"startAt": 6
}Expected Output: The 7th to the 11th projects with their details
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| startAt | No | Zero-indexed starting position. Should be a multiple of maxResults. | |
| 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. |
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. |