ATatlassian
App Properties

Get a Forge app property by key.

Gets a Forge app property by property key. This API can only be accessed using asApp() requests from Forge.

get/app/properties/{propertyKey}

Request

  • Base URL
    https://no-default/wiki/api/v2
  • URL
    https://no-default/wiki/api/v2/app/properties/{propertyKey}
  • Auth
    OAuth 2
    Authorization code: https://auth.atlassian.com/authorize
    Token URL: https://auth.atlassian.com/oauth/token scopes: read:app-data:confluence

Path parameters

propertyKeystring required

The key of the property

Response

App property returned on success.

keystring

The key of the property

valueobject

The value of the property

Example response

{
  "key": "user-preferences",
  "value": {
    "theme": "dark",
    "language": "en"
  }
}

Changes

No recorded changes to this operation across all 5 revisions of this API.