Users

Bulk get users

Changed on

Returns a paginated list of the users specified by one or more account IDs.

Permissions required: Permission to access Jira.

get/rest/api/3/user/bulk

Request

  • Base URL
    https://your-domain.atlassian.net
  • URL
    https://your-domain.atlassian.net/rest/api/3/user/bulk
  • Auth
    • HTTP basic
    • or OAuth 2
      Authorization code: https://auth.atlassian.com/authorize
      Token URL: https://auth.atlassian.com/oauth/token scopes: read:jira-user

Query parameters

startAtinteger

The index of the first item to return in a page of results (page offset).

maxResultsinteger

The maximum number of items to return per page.

usernamestring[]

This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details.

keystring[]

This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details.

accountIdstring[] required

The account ID of a user. To specify multiple users, pass multiple accountId parameters. For example, accountId=5b10a2844c20165700ede21g&accountId=5b10ac8d82e05b22cc7d4ef5.

[
  "5b10ac8d82e05b22cc7d4ef5"
]

Response

Returned if the request is successful.

isLastboolean

Whether this is the last page.

maxResultsinteger

The maximum number of items that could be returned.

nextPagestring uri

If there is another page of results, the URL of the next page.

selfstring uri

The URL of the page.

startAtinteger

The index of the first item returned.

totalinteger

The number of items returned.

Changes

  • 5021849ab549Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status