nav[aria-label="Primary Navigation"] { padding: 0; & ul { list-style: none; width: 100%; display: flex; flex-direction: row; justify-content: start; align-items: start; gap: 30px; padding: 0; & li { margin: 0; } & ul li { list-style: none; } } }

How to get user information from Confluence REST API?

Ashwini Singh

I am trying to get user details like their name, email, phone, about me, department and position.

I am getting only following as response and no expandable properties.

URL - "/rest/api/user?username=sample"

Response

{"type":"known","username":"sample","userKey":"2edfc034541014edfc2c9ba06b8","profilePicture":{"path":"/images/icons/profilepics/default.png","width":48,"height":48,"isDefault":true},"displayName":"Sample, User","_links":{"base":"https://confluence.com","context":"","self":"https://confluence.com/rest/experimental/user?key=2edfc034541014edfc2c9ba06b8"}}

PS - I have modified to JSON details above to hide personal details.

Accepted answers

All comments

Stephen Deutsch

Hi Ashwini,

I'm fairly familiar with the Confluence API and I'm pretty sure that there is no way to get the information that you require via the REST API. Only name and e-mail should be available, but unfortunately phone, about me, department, and position are not accessible.

Arjun Shukla

Hi Stephen,
Can you please share how to get the user's email address.
https://docs.atlassian.com/confluence/REST/6.2.1/#user-getUser

What all is expadable while making the request?

Stephen Deutsch

Hi Arjun,

I stand corrected. It does seem possible to get the details using the new /rest/user API endpoint. Here is the usage:

https://<confluence_url>/<context_path, if there is one>/rest/api/user?username=<username>&expand=details.personal,details.business

details.personal contains phone, website, and e-mail, and details.business contains position, department, and location.

Daniel Sanabria Valdes

Hi Stephen,

I also want to get the email address via REST, but it's missing.

That's what I got for:

GET /rest/api/user?username=myusername&expand=details.personal,details.business

{
"type": "known",
"username": "myusername",
"userKey": "myuserkey",
"profilePicture": {
    "path": "/download/attachments...",
    "width": 48,
    "height": 48,
    "isDefault": false
},
"displayName": "myDisplayName",
"_links": {
    "base": "baseURL",
    "context": "",
    "self": "..."
}
}

We are using the external LDAP user directory. Confluence Version 6.2.1.

Thanks for your help!

Alex van Vucht (GLiNTECH)

In recent versions of Confluence Server, I use three endpoints to get all information on a user:

GET rest/api/user?username=<username>

GET rest/mobile/1.0/profile/<username>

POST rpc/json-rpc/confluenceservice-v2/getUserByName

JSON Body: [<username>]

Nicolas Esteves

Thank you!

Second endpoint is what I was looking for.

Michael Aglas_dd9h0h

is there also an endpoint for groups and their members... If I could just send an email to users of a group as simple as in Jira...

tom_engels

Stephen Deutsch, your second endpoint worked for me perfectly! Thank you! Here's my Python code for anyone else wondering if this still works in 2024... my function is returning the unique confluence user id. The user's email is not included in the response, but I personally only need the user id.

import requests
CONFLUENCE_USER_ENDPOINT = 'https://confluence.company.com/rest/api/user' # Swap for your company's confluence domain


headers = {
"Authorization": f"Bearer: {AUTH_TOKEN}"
}

def get_user_id(self, username: str) -> str:
    get_parameters = {
"username": f"{username}"
    }
    response = requests.get(url=CONFLUENCE_USER_ENDPOINT, headers=headers, params=get_parameters)
print(response.raise_for_status())
return response.json()['userKey']

Heinrich Ulbricht (WikiTraccs)

GET rest/mobile/1.0/profile/<username>

seems to work well for Confluence 7 and 8 (probably also newer), but fails on Confluence 6.6.

Does anybody know the minimum supported Confluence version for this one?

Welcome!

It looks like you're new here. Sign in or register to get started.

Quick Links

Find more posts tagged with

confluence

rest-api