Zephyr: Get Test Plans
zephyr_get_test_plansFetch Test Plans from Zephyr with filters for project, pagination, and recent updates to get detailed plan information.
Instructions
Get details of Test Plans in Zephyr
Toolset: Test Plans
Parameters:
projectKey (string): Jira project key 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 Plans
{
"limit": 10,
"startAtId": 0
}Expected Output: The first 10 Test Plans with their details
Get any Test Plan
{
"limit": 1
}Expected Output: One Test Plan with its details
Get five Test Plans starting from the ID 123
{
"limit": 5,
"startAtId": 123
}Expected Output: Five Test Plans starting from the ID 123 with their details
Get one Test Plan from the project PROJ
{
"projectKey": "PROJ",
"limit": 1
}Expected Output: One Test Plan from project PROJ with its details
Get Test Plans updated after a given time
{
"updatedAfter": "2024-01-01T00:00:00Z",
"limit": 10
}Expected Output: Up to 10 Test Plans updated after 2024-01-01 with their 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. | |
| 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 |