Get user
GET {{baseUrl}}/api/user?key=<string>&username=<string>&accountId=<string>&expand=<string>&expand=<string>
Returns a user. This includes information about the user, such as the display name, account ID, profile picture, and more. The information returned may be restricted by the user's profile visibility settings.
Note: to add, edit, or delete users in your organization, see the user management REST API.
Permissions required: Permission to access the Confluence site ('Can use' global permission).
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
key | string | This parameter is no longer available and will be removed from the documentation soon. | |
Use accountId instead. | |||
| See the deprecation notice for details. | |||
username | string | This parameter is no longer available and will be removed from the documentation soon. | |
Use accountId instead. | |||
| See the deprecation notice for details. | |||
accountId | string | (Required) The account ID of the user, which uniquely identifies the user across all Atlassian products. | |
For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192. | |||
expand | string | A multi-value parameter indicating which properties of the user to | |
| expand. |
-
operationsreturns the operations that the user is allowed to do. -
details.personalreturns the 'Personal' details in the user's profile, like the 'Email' and 'Phone'. Note that these fields have been deprecated due to privacy changes. See the migration guide for details. -
details.businessreturns the 'Company' details in the user's profile, like the 'Position' and 'Department'. Note that these fields have been deprecated due to privacy changes. See the migration guide for details. -
personalSpace returns the user's personal space, if it exists. | |
expand| string | | A multi-value parameter indicating which properties of the user to expand. -
operationsreturns the operations that the user is allowed to do. -
details.personalreturns the 'Personal' details in the user's profile, like the 'Email' and 'Phone'. Note that these fields have been deprecated due to privacy changes. See the migration guide for details. -
details.businessreturns the 'Company' details in the user's profile, like the 'Position' and 'Department'. Note that these fields have been deprecated due to privacy changes. See the migration guide for details. -
personalSpace returns the user's personal space, if it exists. |
RESPONSES
status: OK
{"type":"unknown","accountId":"sit consectetur","accountType":"atlassian","email":"do","publicName":"et nostrud mollit id","profilePicture":{"path":"eiusmod Excepteur","width":61811707,"height":-27758421,"isDefault":true},"displayName":"eiusmod pariatur aliqua cupidatat","_expandable":{"operations":"officia nu","details":"exercitation ipsum elit tempor laborum","personalSpace":"exercitation re"},"_links":{},"username":"sed velit Ut","userKey":"labore anim","operations":[{"operation":"use","targetType":"application"},{"operation":"restore","targetType":"space"}],"details":{"business":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"personal":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"personalSpace":{"id":-69293677,"key":"minim","name":"adipisicing minim nulla nisi consequat","type":"reprehenderit","status":"amet officia pariatur sed","_expandable":{"settings":"deserunt dolore velit laborum","metadata":"ullamco quis non sunt","operations":"qui aliquip","lookAndFeel":"eiusmod cillum ex","permissions":"in ullamco","icon":"veniam quis","description":"officia adip","theme":"ea nisi","history":"aliquip est irure","homepage":"aliqua est deserunt"},"_links":{},"icon":{"path":"adipisicing sed officia","width":33631448,"height":-10767970,"isDefault":true},"description":{"plain":{"value":"cupidatat nulla","representation":"view","embeddedContent":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}]},"view":{"value":"magna aliquip ea","representation":"plain","embeddedContent":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}]}},"homepage":{"value":"\u003cCircular reference to #/components/schemas/Content detected\u003e"},"metadata":{"labels":{"results":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"start":58105433,"limit":10735114,"size":-29792214,"_links":{}}},"operations":[{"operation":"delete","targetType":"blogpost"},{"operation":"restore","targetType":"blogpost"}],"permissions":[{"subjects":{"_expandable":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"user":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"group":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"operation":{"operation":"create","targetType":"page"},"anonymousAccess":false,"unlicensedAccess":false},{"subjects":{"_expandable":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"user":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"group":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"operation":{"operation":"restore","targetType":"blogpost"},"anonymousAccess":false,"unlicensedAccess":false}],"settings":{"routeOverrideEnabled":false,"_links":{}},"theme":{},"lookAndFeel":{"headings":{"color":"\u003cstring\u003e"},"links":{"color":"\u003cstring\u003e"},"menus":{"hoverOrFocus":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"color":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"header":{"backgroundColor":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"button":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"primaryNavigation":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"secondaryNavigation":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"search":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"content":{"screen":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"container":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"header":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"body":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"bordersAndDividers":{"color":"\u003cstring\u003e"}},"history":{"createdDate":"2014-12-12T23:08:45.947Z"}}}