ATatlassian
Board

Get epics

Changed on

Returns all epics from the board, for the given board ID. This only includes epics that the user has permission to view. Note, if the user does not have permission to view the board, no epics will be returned at all.

get/rest/agile/1.0/board/{boardId}/epic

Request

  • Base URL
    https://your-domain.atlassian.net
  • URL
    https://your-domain.atlassian.net/rest/agile/1.0/board/{boardId}/epic
  • Auth
    • HTTP basic
    • or OAuth 2
      Authorization code: https://auth.atlassian.com/authorize
      Token URL: https://auth.atlassian.com/oauth/token scopes: read:epic:jira-software

Path parameters

boardIdinteger required

The ID of the board that contains the requested epics.

Query parameters

startAtinteger

The starting index of the returned epics. Base index: 0. See the 'Pagination' section at the top of this page for more details.

maxResultsinteger

The maximum number of epics to return per page. See the 'Pagination' section at the top of this page for more details.

donestring

Filters results to epics that are either done or not done. Valid values: true, false.

Response

Returns the requested epics, at the specified page of the results.

Changes