v1

latestOpenAPI 3.0.12026-07-13130168404.3 KB
User properties

Get user property

Returns the property corresponding to key for a user. For more information about user properties, see Confluence entity properties. Note, these properties stored against a user are on a Confluence site level and not space/content level.

Permissions required: Permission to access the Confluence site ('Can use' global permission).

get/wiki/rest/api/user/{userId}/property/{key}

Path parameters

userIdstring required

The account ID of the user to be queried for its properties.

keystring required

The key of the user property.

Response

Returned if the requested properties are returned.

keystring required
valueobject required

The value of the content property.

idstring required

a unique identifier for the user property

lastModifiedDatestring date-time required

datetime when the property was last modified such as 2022-02-01T12:00:00.111Z

createdDatestring date-time required

datetime when the property was created such as 2022-01-01T12:00:00.111Z

_linksGenericLinks