GET /rest/api/2/user

Returns a user.

Privacy controls are applied to the response based on the user's preferences. This could mean, for example, that the user's email address is hidden. See the Profile visibility overview for more details.

Permissions required: Browse users and groups global permission.

Servers

Query parameters

Name Type Required Description
username String No

This parameter is no longer available. See the deprecation notice for details.

accountId String No

The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. Required.

key String No

This parameter is no longer available. See the deprecation notice for details.

expand String No

Use expand to include additional information about users in the response. This parameter accepts a comma-separated list. Expand options include:

  • groups includes all groups and nested groups to which the user belongs.
  • applicationRoles includes details of all the applications to which the user has access.

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.