ATatlassian
Sprint

Get property

Changed on

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

get/rest/agile/1.0/sprint/{sprintId}/properties/{propertyKey}

Request

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

Path parameters

sprintIdstring required

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

propertyKeystring required

the key of the property to return.

Response

Returned if the sprint exists and the property was found.

Changes