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).

External Documentation

To learn more, visit the Confluence documentation.

​
Parameters

ParameterDescription
Account IDThe account ID of the user, which uniquely identifies the user across all Atlassian products.For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192.
ExpandA multi-value parameter indicating which properties of the user toexpand. - operations returns the operations that the user is allowed to do. - details.personal returns 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.business returns 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.

​
Example Output

{
	"_expandable": {
		"details": "string",
		"operations": "string",
		"personalSpace": "string"
	},
	"_links": {},
	"accountId": "The account ID of the user, which uniquely identifies the user across all Atlassian products.\nFor example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`.",
	"accountType": "The account type of the user, may return empty string if unavailable.",
	"details": {
		"business": {
			"department": "This property has been deprecated due to privacy changes. There is no replacement. See the\n[migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\nfor details.",
			"location": "This property has been deprecated due to privacy changes. There is no replacement. See the\n[migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\nfor details.",
			"position": "This property has been deprecated due to privacy changes. There is no replacement. See the\n[migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\nfor details."
		},
		"personal": {
			"email": "This property has been deprecated due to privacy changes. Use the `User.email` property instead. See the\n[migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\nfor details.",
			"im": "This property has been deprecated due to privacy changes. There is no replacement. See the\n[migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\nfor details.",
			"phone": "This property has been deprecated due to privacy changes. There is no replacement. See the\n[migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\nfor details.",
			"website": "This property has been deprecated due to privacy changes. There is no replacement. See the\n[migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\nfor details."
		}
	},
	"displayName": "The display name of the user. Depending on the user's privacy setting, this may be the same as publicName.",
	"email": "The email address of the user. Depending on the user's privacy setting, this may return an empty string.",
	"operations": [
		{
			"operation": "The operation itself.",
			"targetType": "The space or content type that the operation applies to."
		}
	],
	"personalSpace": {
		"_expandable": {
			"description": "string",
			"history": "string",
			"homepage": "string",
			"icon": "string",
			"lookAndFeel": "string",
			"metadata": "string",
			"operations": "string",
			"permissions": "string",
			"settings": "string",
			"theme": "string"
		},
		"_links": {},
		"description": {
			"plain": {
				"embeddedContent": [
					{}
				],
				"representation": "string",
				"value": "string"
			},
			"view": {
				"embeddedContent": [
					{}
				],
				"representation": "string",
				"value": "string"
			}
		},
		"history": {
			"createdDate": "date-time"
		},
		"homepage": {
			"_expandable": {
				"ancestors": "string",
				"body": "string",
				"childTypes": "string",
				"children": "string",
				"container": "string",
				"descendants": "string",
				"history": "string",
				"metadata": "string",
				"operations": "string",
				"restrictions": "string",
				"space": "string",
				"version": "string"
			},
			"_links": {},
			"ancestors": [
				null
			],
			"body": {
				"_expandable": {
					"anonymous_export_view": "string",
					"editor": "string",
					"editor2": "string",
					"export_view": "string",
					"storage": "string",
					"styled_view": "string",
					"view": "string"
				},
				"anonymous_export_view": {
					"_expandable": {
						"content": "string"
					},
					"embeddedContent": [
						{
							"entity": {},
							"entityId": 0
						}
					],
					"representation": "string",
					"value": "string",
					"webresource": {
						"contexts": [
							"string"
						],
						"keys": [
							"string"
						],
						"superbatch": {
							"metatags": "string",
							"tags": {
								"all": "string",
								"css": "string",
								"data": "string",
								"js": "string"
							},
							"uris": {
								"all": "string",
								"css": "string",
								"js": "string"
							}
						},
						"tags": {
							"all": "string",
							"css": "string",
							"data": "string",
							"js": "string"
						},
						"uris": {
							"all": "string",
							"css": "string",
							"js": "string"
						}
					}
				},
				"editor2": {
					"_expandable": {
						"content": "string"
					},
					"embeddedContent": [
						{
							"entity": {},
							"entityId": 0
						}
					],
					"representation": "string",
					"value": "string",
					"webresource": {
						"contexts": [
							"string"
						],
						"keys": [
							"string"
						],
						"superbatch": {
							"metatags": "string",
							"tags": {
								"all": "string",
								"css": "string",
								"data": "string",
								"js": "string"
							},
							"uris": {
								"all": "string",
								"css": "string",
								"js": "string"
							}
						},
						"tags": {
							"all": "string",
							"css": "string",
							"data": "string",
							"js": "string"
						},
						"uris": {
							"all": "string",
							"css": "string",
							"js": "string"
						}
					}
				},
				"export_view": {
					"_expandable": {
						"content": "string"
					},
					"embeddedContent": [
						{
							"entity": {},
							"entityId": 0
						}
					],
					"representation": "string",
					"value": "string",
					"webresource": {
						"contexts": [
							"string"
						],
						"keys": [
							"string"
						],
						"superbatch": {
							"metatags": "string",
							"tags": {
								"all": "string",
								"css": "string",
								"data": "string",
								"js": "string"
							},
							"uris": {
								"all": "string",
								"css": "string",
								"js": "string"
							}
						},
						"tags": {
							"all": "string",
							"css": "string",
							"data": "string",
							"js": "string"
						},
						"uris": {
							"all": "string",
							"css": "string",
							"js": "string"
						}
					}
				},
				"storage": {
					"_expandable": {
						"content": "string"
					},
					"embeddedContent": [
						{
							"entity": {},
							"entityId": 0
						}
					],
					"representation": "string",
					"value": "string",
					"webresource": {
						"contexts": [
							"string"
						],
						"keys": [
							"string"
						],
						"superbatch": {
							"metatags": "string",
							"tags": {
								"all": "string",
								"css": "string",
								"data": "string",
								"js": "string"
							},
							"uris": {
								"all": "string",
								"css": "string",
								"js": "string"
							}
						},
						"tags": {
							"all": "string",
							"css": "string",
							"data": "string",
							"js": "string"
						},
						"uris": {
							"all": "string",
							"css": "string",
							"js": "string"
						}
					}
				},
				"styled_view": {
					"_expandable": {
						"content": "string"
					},
					"embeddedContent": [
						{
							"entity": {},
							"entityId": 0
						}
					],
					"representation": "string",
					"value": "string",
					"webresource": {
						"contexts": [
							"string"
						],
						"keys": [
							"string"
						],
						"superbatch": {
							"metatags": "string",
							"tags": {
								"all": "string",
								"css": "string",
								"data": "string",
								"js": "string"
							},
							"uris": {
								"all": "string",
								"css": "string",
								"js": "string"
							}
						},
						"tags": {
							"all": "string",
							"css": "string",
							"data": "string",
							"js": "string"
						},
						"uris": {
							"all": "string",
							"css": "string",
							"js": "string"
						}
					}
				},
				"view": {
					"_expandable": {
						"content": "string"
					},
					"embeddedContent": [
						{
							"entity": {},
							"entityId": 0
						}
					],
					"representation": "string",
					"value": "string",
					"webresource": {
						"contexts": [
							"string"
						],
						"keys": [
							"string"
						],
						"superbatch": {
							"metatags": "string",
							"tags": {
								"all": "string",
								"css": "string",
								"data": "string",
								"js": "string"
							},
							"uris": {
								"all": "string",
								"css": "string",
								"js": "string"
							}
						},
						"tags": {
							"all": "string",
							"css": "string",
							"data": "string",
							"js": "string"
						},
						"uris": {
							"all": "string",
							"css": "string",
							"js": "string"
						}
					}
				}
			},
			"childTypes": {
				"_expandable": {
					"all": "string",
					"attachment": "string",
					"comment": "string",
					"page": "string"
				},
				"attachment": {
					"_links": {},
					"value": false
				},
				"comment": {
					"_links": {},
					"value": false
				},
				"page": {
					"_links": {},
					"value": false
				}
			},
			"children": {
				"_expandable": {
					"attachment": "string",
					"comment": "string",
					"page": "string"
				},
				"_links": {},
				"attachment": {
					"_links": {},
					"limit": 0,
					"results": [
						null
					],
					"size": 0,
					"start": 0
				},
				"comment": {
					"_links": {},
					"limit": 0,
					"results": [
						null
					],
					"size": 0,
					"start": 0
				},
				"page": {
					"_links": {},
					"limit": 0,
					"results": [
						null
					],
					"size": 0,
					"start": 0
				}
			},
			"container": {},
			"descendants": {
				"_expandable": {
					"attachment": "string",
					"comment": "string",
					"page": "string"
				},
				"_links": {},
				"attachment": {
					"_links": {},
					"limit": 0,
					"results": [
						null
					],
					"size": 0,
					"start": 0
				},
				"comment": {
					"_links": {},
					"limit": 0,
					"results": [
						null
					],
					"size": 0,
					"start": 0
				},
				"page": {
					"_links": {},
					"limit": 0,
					"results": [
						null
					],
					"size": 0,
					"start": 0
				}
			},
			"history": {
				"_expandable": {
					"contributors": "string",
					"lastUpdated": "string",
					"nextVersion": "string",
					"previousVersion": "string"
				},
				"_links": {},
				"contributors": {
					"publishers": {
						"_links": {},
						"userKeys": [
							"string"
						],
						"users": [
							null
						]
					}
				},
				"createdDate": "date-time",
				"lastUpdated": {
					"_expandable": {
						"collaborators": "string",
						"content": "string"
					},
					"_links": {},
					"collaborators": {
						"_links": {},
						"userKeys": [
							"string"
						],
						"users": [
							null
						]
					},
					"friendlyWhen": "string",
					"message": "string",
					"minorEdit": false,
					"number": 0,
					"when": "date-time"
				},
				"latest": false,
				"nextVersion": {
					"_expandable": {
						"collaborators": "string",
						"content": "string"
					},
					"_links": {},
					"collaborators": {
						"_links": {},
						"userKeys": [
							"string"
						],
						"users": [
							null
						]
					},
					"friendlyWhen": "string",
					"message": "string",
					"minorEdit": false,
					"number": 0,
					"when": "date-time"
				},
				"previousVersion": {
					"_expandable": {
						"collaborators": "string",
						"content": "string"
					},
					"_links": {},
					"collaborators": {
						"_links": {},
						"userKeys": [
							"string"
						],
						"users": [
							null
						]
					},
					"friendlyWhen": "string",
					"message": "string",
					"minorEdit": false,
					"number": 0,
					"when": "date-time"
				}
			},
			"id": "string",
			"operations": [
				{
					"operation": "The operation itself.",
					"targetType": "The space or content type that the operation applies to."
				}
			],
			"restrictions": {
				"_links": {},
				"read": {
					"_expandable": {
						"content": "string",
						"restrictions": "string"
					},
					"_links": {},
					"operation": "string",
					"restrictions": {
						"_expandable": {
							"group": "string",
							"user": "string"
						},
						"group": {
							"limit": 0,
							"results": [
								{
									"_links": {},
									"id": "string",
									"name": "string",
									"type": "group"
								}
							],
							"size": 0,
							"start": 0
						},
						"user": {
							"limit": 0,
							"results": [
								null
							],
							"size": 0,
							"start": 0
						}
					}
				},
				"update": {
					"_expandable": {
						"content": "string",
						"restrictions": "string"
					},
					"_links": {},
					"operation": "string",
					"restrictions": {
						"_expandable": {
							"group": "string",
							"user": "string"
						},
						"group": {
							"limit": 0,
							"results": [
								{
									"_links": {},
									"id": "string",
									"name": "string",
									"type": "group"
								}
							],
							"size": 0,
							"start": 0
						},
						"user": {
							"limit": 0,
							"results": [
								null
							],
							"size": 0,
							"start": 0
						}
					}
				}
			},
			"status": "string",
			"title": "string",
			"type": "string",
			"version": {
				"_expandable": {
					"collaborators": "string",
					"content": "string"
				},
				"_links": {},
				"collaborators": {
					"_links": {},
					"userKeys": [
						"string"
					],
					"users": [
						null
					]
				},
				"friendlyWhen": "string",
				"message": "string",
				"minorEdit": false,
				"number": 0,
				"when": "date-time"
			}
		},
		"icon": {
			"height": 0,
			"isDefault": false,
			"path": "string",
			"width": 0
		},
		"id": 0,
		"key": "string",
		"lookAndFeel": {
			"bordersAndDividers": {
				"color": "string"
			},
			"content": {
				"body": {
					"background": "string",
					"backgroundColor": "string",
					"backgroundImage": "string",
					"backgroundSize": "string",
					"borderRadius": "string",
					"padding": "string"
				},
				"container": {
					"background": "string",
					"backgroundColor": "string",
					"backgroundImage": "string",
					"backgroundSize": "string",
					"borderRadius": "string",
					"padding": "string"
				},
				"header": {
					"background": "string",
					"backgroundColor": "string",
					"backgroundImage": "string",
					"backgroundSize": "string",
					"borderRadius": "string",
					"padding": "string"
				},
				"screen": {
					"background": "string",
					"backgroundColor": "string",
					"backgroundImage": "string",
					"backgroundSize": "string",
					"gutterBottom": "string",
					"gutterLeft": "string",
					"gutterRight": "string",
					"gutterTop": "string"
				}
			},
			"header": {
				"backgroundColor": "string",
				"button": {
					"backgroundColor": "string",
					"color": "string"
				},
				"primaryNavigation": {
					"color": "string",
					"hoverOrFocus": {
						"backgroundColor": "string",
						"color": "string"
					}
				},
				"search": {
					"backgroundColor": "string",
					"color": "string"
				},
				"secondaryNavigation": {
					"color": "string",
					"hoverOrFocus": {
						"backgroundColor": "string",
						"color": "string"
					}
				}
			},
			"headings": {
				"color": "string"
			},
			"links": {
				"color": "string"
			},
			"menus": {
				"color": "string",
				"hoverOrFocus": {
					"backgroundColor": "string"
				}
			}
		},
		"metadata": {
			"labels": {
				"_links": {},
				"limit": 0,
				"results": [
					{
						"id": "string",
						"label": "string",
						"name": "string",
						"prefix": "string"
					}
				],
				"size": 0,
				"start": 0
			}
		},
		"name": "string",
		"operations": [
			{
				"operation": "The operation itself.",
				"targetType": "The space or content type that the operation applies to."
			}
		],
		"permissions": [
			{
				"anonymousAccess": false,
				"operation": {
					"operation": "The operation itself.",
					"targetType": "The space or content type that the operation applies to."
				},
				"subjects": {
					"_expandable": {
						"group": "string",
						"user": "string"
					},
					"group": {
						"results": [
							{
								"_links": {},
								"id": "string",
								"name": "string",
								"type": "group"
							}
						],
						"size": 0
					},
					"user": {
						"results": [
							null
						],
						"size": 0
					}
				},
				"unlicensedAccess": false
			}
		],
		"settings": {
			"_links": {},
			"routeOverrideEnabled": false
		},
		"status": "string",
		"theme": {
			"_links": {},
			"description": "string",
			"icon": {
				"height": 0,
				"isDefault": false,
				"path": "string",
				"width": 0
			},
			"name": "string",
			"themeKey": "string"
		},
		"type": "string"
	},
	"profilePicture": {
		"height": 0,
		"isDefault": false,
		"path": "string",
		"width": 0
	},
	"publicName": "The public name or nickname of the user. Will always contain a value.",
	"type": "string",
	"userKey": "This property is no longer available and will be removed from the documentation soon.\nUse `accountId` instead.\nSee the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.",
	"username": "This property is no longer available and will be removed from the documentation soon.\nUse `accountId` instead.\nSee the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details."
}

​
Workflow Library Example

Get User with Confluence and Send Results Via Email

Preview this Workflow on desktop

Was this page helpful?