GET /wiki/rest/api/user/{userId}/property

Returns the properties for a user as list of property keys. 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).

Servers

Path parameters

Name Type Required Description
userId String Yes

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

Query parameters

Name Type Required Description
limit Integer No

The maximum number of properties to return per page. Note, this may be restricted by fixed system limits.

Default value: 5

start Integer No

The starting index of the returned properties.

Default value: 0

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.