ATatlassian
Board

Get board property

Changed on

Returns the value of the property with a given key from the board identified by the provided id. The user who retrieves the property is required to have permissions to view the board.

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

Request

  • Base URL
    https://your-domain.atlassian.net
  • URL
    https://your-domain.atlassian.net/rest/agile/1.0/board/{boardId}/properties/{propertyKey}
  • 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.admin:jira-software
    • or none

Path parameters

boardIdstring required

the ID of the board from which the property will be returned.

propertyKeystring required

the key of the property to return.

Response

Returned if the board exists and the property was found.

Changes