GitLab Iterations API

openapi: 3.2.0
info:
  title: GitLab REST Iterations API
  description: GitLab REST API used to interact with a GitLab installation.
  termsOfService: https://handbook.gitlab.com/handbook/legal/api-terms/
  version: '19.6'
  license:
    name: CC BY-SA 4.0
    url: https://gitlab.com/gitlab-org/gitlab/-/blob/master/LICENSE
    x-gitlab-description: The license applies to the OpenAPI specification document itself. For terms governing use of the GitLab API, see the termsOfService field.
servers:
- url: https://{hostname}
  description: GitLab REST API
  variables:
    hostname:
      default: gitlab.com
      description: Your GitLab instance hostname
security:
- http: []
- oauth2: []
- apiKey: []
tags:
- name: Iterations
  description: 'Use this API to retrieve iterations for a group or

    a project.


    Projects no longer have their own iterations, but you can use the project endpoint to retrieve the

    iterations of a project''s ancestor groups.'
  x-displayName: Iterations
  externalDocs:
    url: https://docs.gitlab.com/api/group_iterations/
paths:
  /api/v4/projects/{id}/iterations:
    get:
      operationId: getApiV4ProjectsIdIterations
      summary: List all project iterations
      description: Lists all iterations for a specified project. Iterations created by **Enable automatic scheduling** in iteration cadences return `null` for the `title` and `description` fields. This feature was introduced in GitLab 13.5.
      tags:
      - Iterations
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/APIEntitiesIteration'
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
        example: 5
      - name: state
        required: false
        description: Filter iterations by state. Filtering by `started` is deprecated. Use `current` instead.
        schema:
          type: string
          enum:
          - opened
          - upcoming
          - started
          - current
          - closed
          - all
          default: all
        in: query
        example: opened
      - name: search
        required: false
        description: Return only iterations with a title matching the provided string.
        schema:
          type:
          - string
          - 'null'
        in: query
        example: version
      - name: in
        required: false
        description: Fields to search with the `search` query. Possible values are `title` and `cadence_title`.
        schema:
          type: array
          items:
            type: string
            enum:
            - title
            - cadence_title
          default:
          - title
        in: query
        example:
        - title
        - cadence_title
      - name: include_ancestors
        required: false
        description: If `true`, includes iterations for the parent group and its ancestors.
        schema:
          type: boolean
          default: true
        in: query
        example: false
      - name: include_descendants
        required: false
        description: If `true`, includes iterations for the parent group and its descendants.
        schema:
          type: boolean
          default: false
        in: query
        example: true
      - name: updated_before
        required: false
        description: 'Return milestones updated before the specified datetime. Format: ISO 8601 YYYY-MM-DDTHH:MM:SSZ'
        schema:
          type:
          - string
          - 'null'
          format: date-time
        in: query
        example: '2023-02-28T21:22:12Z'
      - name: updated_after
        required: false
        description: 'Return milestones updated after the specified datetime. Format: ISO 8601 YYYY-MM-DDTHH:MM:SSZ'
        schema:
          type:
          - string
          - 'null'
          format: date-time
        in: query
        example: '2023-02-28T21:22:12Z'
      - name: page
        required: false
        description: Page number of results to retrieve.
        schema:
          type: integer
          default: 1
        in: query
        example: 1
      - name: per_page
        required: false
        description: Number of items to list per page.
        schema:
          type: integer
          default: 20
        in: query
        example: 20
      x-gitlab-tier: premium
  /api/v4/groups/{id}/iterations:
    get:
      operationId: getApiV4GroupsIdIterations
      summary: List all group iterations
      description: Lists all iterations for a specified group. Iterations created by **Enable automatic scheduling** in iteration cadences return `null` for the `title` and `description` fields. This feature was introduced in GitLab 13.5.
      tags:
      - Iterations
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/APIEntitiesIteration'
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the group.
        schema:
          type: string
        in: path
        example: '5'
      - name: state
        required: false
        description: Filter iterations by state. Filtering by `started` is deprecated. Use `current` instead.
        schema:
          type: string
          enum:
          - opened
          - upcoming
          - started
          - current
          - closed
          - all
          default: all
        in: query
        example: opened
      - name: search
        required: false
        description: Return only iterations with a title matching the provided string.
        schema:
          type:
          - string
          - 'null'
        in: query
        example: version
      - name: in
        required: false
        description: Fields to search with the `search` query. Possible values are `title` and `cadence_title`.
        schema:
          type: array
          items:
            type: string
            enum:
            - title
            - cadence_title
          default:
          - title
        in: query
        example:
        - title
        - cadence_title
      - name: include_ancestors
        required: false
        description: If `true`, includes iterations for the parent group and its ancestors.
        schema:
          type: boolean
          default: true
        in: query
        example: false
      - name: include_descendants
        required: false
        description: If `true`, includes iterations for the parent group and its descendants.
        schema:
          type: boolean
          default: false
        in: query
        example: true
      - name: updated_before
        required: false
        description: 'Return milestones updated before the specified datetime. Format: ISO 8601 YYYY-MM-DDTHH:MM:SSZ'
        schema:
          type:
          - string
          - 'null'
          format: date-time
        in: query
        example: '2023-02-28T21:22:12Z'
      - name: updated_after
        required: false
        description: 'Return milestones updated after the specified datetime. Format: ISO 8601 YYYY-MM-DDTHH:MM:SSZ'
        schema:
          type:
          - string
          - 'null'
          format: date-time
        in: query
        example: '2023-02-28T21:22:12Z'
      - name: page
        required: false
        description: Page number of results to retrieve.
        schema:
          type: integer
          default: 1
        in: query
        example: 1
      - name: per_page
        required: false
        description: Number of items to list per page.
        schema:
          type: integer
          default: 20
        in: query
        example: 20
      x-gitlab-tier: premium
components:
  schemas:
    APIEntitiesIteration:
      type: object
      properties:
        id:
          type: integer
          format: int64
          example: 1
        iid:
          type: integer
          example: 1
        sequence:
          type: integer
          example: 1
        group_id:
          type: integer
          format: int64
          example: 1
        title:
          type: string
          example: Iteration I
        description:
          type: string
          example: Iteration description
        state:
          type: integer
          example: 1
        created_at:
          type: string
          format: date-time
          example: '2022-01-31T15:10:45.080Z'
        updated_at:
          type: string
          format: date-time
          example: '2022-01-31T15:10:45.080Z'
        start_date:
          type: string
          format: date
          example: '2022-01-01'
        due_date:
          type: string
          format: date
          example: '2022-01-31'
        web_url:
          type: string
          example: https://gitlab.example.com/groups/gitlab-org/-/iterations/1
  securitySchemes:
    http:
      type: http
      scheme: bearer
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://gitlab.com/oauth/authorize
          tokenUrl: https://gitlab.com/oauth/token
          refreshUrl: https://gitlab.com/oauth/token
          scopes:
            api: Grants complete read/write access to the API, including all groups and projects, the container registry, the dependency proxy, and the package registry.
            read_api: Grants read access to the API, including all groups and projects, the container registry, and the package registry.
            read_user: Grants read-only access to your profile through the /user API endpoint, which includes username, public email, and full name. Also grants access to read-only API endpoints under /users.
            create_runner: Grants create access to the runners.
            manage_runner: Grants access to manage the runners.
            k8s_proxy: Grants permission to perform Kubernetes API calls using the agent for Kubernetes.
            self_rotate: Grants permission for token to rotate itself.
            mcp: Grants read-write access to remote Model Context Protocol (MCP) server for tools execution.
            mcp_orbit: Grants access to the Orbit Knowledge Graph MCP server for graph queries and schema retrieval.
    apiKey:
      type: apiKey
      name: PRIVATE-TOKEN
      in: header