Find ri:userkey value using the Confluence API

Chris P. May 2, 2020

Hello there,

Is there a way to use the Confluence API to receive the "ri:usekey" value?

Referring to:

Confluence Cloud REST API Developer Guide 


Deprecation notice and migration guide for major changes to Confluence Cloud REST APIs to improve user privacy 

We are able to to get user information, using the "Get user" API, if I know the {accountID}, using GET of said user in advance.{accountId} 


However, there are a few page macros, for example:

  • Profile Picture macro
  • User Profile macro

that when viewing the HTML source, the macro object uses the "ri:userkey" value, and not the {accountID}.

<ri:user ri:userkey="8a7f808565a1b953011234567890z" />


We maintain quite a large number of individual profile pages, which we deploy and maintain 100% via the Confluence API.


Couple of questions:

  1. Is there / will there ever be a method of finding out the {accountID} value for a user, using their name?
    1. We currently only know that we have to maintain MANUALLY, an external lookup mechanism to match a user to their Confluence accountID (for example table lookup, or, database lookup)
  2. More importantly:  is there a way to use to:
    1. Lookup the ri:userkey via API ?



Thank you in advance for you feedback & advice.



Luke July 3, 2020

I am also trying to find the solution to this problem

Like Peng Xiao likes this
Steve Eckhart August 7, 2020

I also need to be able to retrieve the user's Display Name from the ri:userkey in the User Profile macro.

Onno Broekmans January 13, 2021

It indeed looks like this is an unfortunate interaction between the GDPR migration you referenced, and the XML storage format for these macros. In any case, it's preventing me from matching a User Mention to a human-readable name.

Is there any kind of API, private or not, that can be used to match a user key to a name or account ID?

  • The official API appears to have all mentions of a "user key" carefully stripped out, probably because of aforementioned GDPR migration.
  • I tried the "rest/api/search/user" endpoint, but couldn't find a CQL query that allows for searching by the old-fashioned user key.
  • There's an interesting "rest/experimental/cql/pdcleaner" endpoint, but I never managed to get it to actually return anything.
Paweł Gołębiewski January 28, 2021

I have the same issue. Really need the `ri:user ri:userkey` to generate some pages :/


Well, it turns out, you can reference it using username, which can be accountId.

<ri:user ri:username="8a7f808565a1b953011234567890z"/>


I've tested it on profile picture macro and it works!



To get accountID you can use this API call (where org is your organization name):

With CQL query (, fullname used as example

cql = user.fullname~"surname"

So the full query will look like this:


Like # people like this
Vaidik Kapoor March 26, 2021

Confirming that this works. I was able it generate pages using this way.

Luke March 26, 2021

Unfortunately this does not work for the reverse case though. When confluence generates the html for a user being mentioned on the page, it will use the userkey (as per the original post in this ticket).

There is still no way to look up the userkey and convert it to an accountId, as far as I am aware.

Like Bing Wu likes this
Logan McGhee December 7, 2021

I came across this message (and several other threads) as the result of getting the userkey from confluence pages that I was retrieving via the API.

When using expander as part of the request, the response was providing userkey values which, as of GDPR changes, are effectively useless.

However, using the expander body.view as part of the request, the response sends back the appropriate accountID value of mentions in the page.

Hoping that this information helps people not waste the same time that I did.
Please leave me a 👍 if this helped you so I can feel my time was worthwhile 😅

Like # people like this
Jen McVicker
Atlassian Team
Atlassian Team members are employees working across the company in a wide variety of roles.
May 12, 2022

Worked for me too!

Arturo Kirkconnell November 4, 2022

Awesome Thanks!!


Log in or Sign up to comment
AUG Leaders

Atlassian Community Events