Atlassian uses cookies to improve your browsing experience, perform analytics and research, and conduct advertising. Accept all cookies to indicate that you agree to our use of cookies on your device. Atlassian cookies and tracking notice, (opens new window)
Teams
, (opens new window)
Confluence Command Line Interface (CLI)
Results will update as you type.
  • Client Reference Types
    • Agile Client Reference
      • Agile Client Action Categories
      • Agile Client Actions
        • addBoardAdministrators
        • addBoardColumn
        • addIssuesToSprint
        • addQuickFilter
        • completeSprint
        • copyBoard
        • createBoard
        • createSprint
        • deleteBoard
        • deleteSprint
        • getBoard
        • getBoardColumnList
        • getBoardList
        • getQuickFilter
        • getQuickFilterList
        • getSprint
        • getSprintList
        • removeBoardColumn
        • removeQuickFilter
        • runFromBoardList
        • runFromQuickFilterList
        • runFromSprintList
        • setBoardAdministrators
        • startSprint
        • updateBoard
        • updateBoardCard
        • updateBoardColumn
        • updateQuickFilter
        • updateSprint
      • Agile Client Parameters
      • Agile Client Examples
    • CSV Client Reference
    • JSM Client Reference
    • System Client Reference
    • Web Client Reference
  • User's Guide
  • Administrator's Guide
  • Release notes
    You‘re viewing this with anonymous access, so some content might be blocked.
    /
    getSprint

    getSprint

    Nov 18, 2024

    See also: Agile Client Actions

    Description

    Get information about a sprint. Use the sprint parameter for sprint name or id. Use the board parameter to lookup the sprint in a particular board.

    Required Parameters

    sprint

    Optional Parameters

    board, outputType, file, append, encoding

    Type

    Get

    Category

    Sprints

    Output Formats

    Replacement Variables

    sprint, sprintId

    Hostingcloud,server,datacenter
    Since Version

    Examples

    getSprint

    Related How To's

    , multiple selections available, Use left or right arrow keys to navigate selected items
    cli-action
    cli-action-getsprint
    cli-action-category-sprints
    cli-parameter-debug
    cli-action-type-get
    cli-parameter-special
    cli-parameter-outputtype
    cli-parameter-verbose
    cli-parameter-quiet
    cli-parameter-dateformat
    cli-parameter-action
    cli-parameter-help
    cli-parameter-dateformat2
    cli-parameter-encoding
    cli-parameter-file
    cli-parameter-append
    cli-parameter-board
    cli-parameter-sprint

    Need support? Create a request with our support team.

    Copyright © 2005 - 2025 Appfire | All rights reserved.

    {"serverDuration": 26, "requestCorrelationId": "8262fce18cc742c99ce5e0666f97b8c6"}