list_group_iterations
Retrieve and filter GitLab group iterations by state, search terms, or timeframe to manage project timelines and track progress.
Instructions
List group iterations with filtering options
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| group_id | No | Group ID or URL-encoded path | |
| state | No | Return opened, upcoming, current, closed, or all iterations. | |
| search | No | Return only iterations with a title matching the provided string. | |
| search_in | No | Fields in which fuzzy search should be performed with the query given in the argument search. The available options are title and cadence_title. Default is [title]. | |
| include_ancestors | No | Include iterations for group and its ancestors. Defaults to true. | |
| include_descendants | No | Include iterations for group and its descendants. Defaults to false. | |
| updated_before | No | Return only iterations updated before the given datetime. Expected in ISO 8601 format (2019-03-15T08:00:00Z). | |
| updated_after | No | Return only iterations updated after the given datetime. Expected in ISO 8601 format (2019-03-15T08:00:00Z). | |
| page | No | Page number for pagination (default: 1) | |
| per_page | No | Number of items per page (max: 100, default: 20) |
Implementation Reference
- schemas.ts:1939-1976 (schema)Input schema (parameters) for the 'list_group_iterations' tool, defining validation for group_id and optional filters like state, search, pagination matching GitLab Groups Iterations API.
export const ListGroupIterationsSchema = z .object({ group_id: z.coerce.string().describe("Group ID or URL-encoded path"), state: z .enum(["opened", "upcoming", "current", "closed", "all"]) .optional() .describe("Return opened, upcoming, current, closed, or all iterations."), search: z .string() .optional() .describe("Return only iterations with a title matching the provided string."), search_in: z .array(z.enum(["title", "cadence_title"])) .optional() .describe( "Fields in which fuzzy search should be performed with the query given in the argument search. The available options are title and cadence_title. Default is [title]." ), include_ancestors: z.boolean() .optional() .describe("Include iterations for group and its ancestors. Defaults to true."), include_descendants: z.boolean() .optional() .describe("Include iterations for group and its descendants. Defaults to false."), updated_before: z .string() .optional() .describe( "Return only iterations updated before the given datetime. Expected in ISO 8601 format (2019-03-15T08:00:00Z)." ), updated_after: z .string() .optional() .describe( "Return only iterations updated after the given datetime. Expected in ISO 8601 format (2019-03-15T08:00:00Z)." ), }) .merge(PaginationOptionsSchema); - schemas.ts:1924-1937 (schema)Output schema defining the structure of a GitLab Group Iteration object returned by the 'list_group_iterations' tool.
export const GroupIteration = z.object({ id: z.coerce.string(), iid: z.coerce.string(), sequence: z.number(), group_id: z.coerce.string(), title: z.string().optional().nullable(), description: z.string().optional().nullable(), state: z.number(), created_at: z.string(), updated_at: z.string(), due_date: z.string().optional().nullable(), start_date: z.string().optional().nullable(), web_url: z.string().optional().nullable(), });