provider Users GET
/rest/api/3/user/bulk @utdk/jira
/rest/api/3/user/bulk Bulk get users
Returns a [paginated](#pagination) list of the users specified by one or more account IDs.
**[Permissions](#permissions) required:** Permission to access Jira.
- startAt query
- The index of the first item to return in a page of results (page offset).
- integer
- maxResults query
- The maximum number of items to return per page.
- integer
- username query
- This parameter is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.
- array
- key query
- This parameter is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.
- array
- accountId query required
- The account ID of a user. To specify multiple users, pass multiple `accountId` parameters. For example, `accountId=5b10a2844c20165700ede21g&accountId=5b10ac8d82e05b22cc7d4ef5`.
- array
Try it
Authentication
Configure credentials for The Jira Cloud platform REST API
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.
Saved automatically to browser storage.
Code snippet
Updates live as you fill in the form above.
TypeScript
import jira from '@utdk/jira';
await jira.bulkgetusers({
"startAt": 0,
"maxResults": 10
})