ATatlassian
Board

Get board

Changed on

Returns the board for the given board ID. This board will only be returned if the user has permission to view it. Admins without the view permission will see the board as a private one, so will see only a subset of the board's data (board location for instance).

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

Request

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

Path parameters

boardIdinteger required

The ID of the requested board.

Response

Returns the requested board.

canEditboolean

Whether the board can be edited.

favouriteboolean

Whether the board is selected as a favorite.

idinteger

The ID of the board.

isPrivateboolean

Whether the board is private.

namestring

The name of the board.

selfstring uri

The URL of the board.

typestring

The type the board.

Changes