Find Users Assignable To Issues

GET {{baseUrl}}/rest/api/3/user/assignable/search?query=<string>&sessionId=<string>&username=<string>&accountId=<string>&project=<string>&issueKey=<string>&startAt=0&maxResults=50&actionDescriptorId=<integer>&recommend=false

Returns a list of users that can be assigned to an issue. Use this operation to find the list of users who can be assigned to:

a new issue, by providing the projectKeyOrId.
an updated issue, by providing the issueKey.
to an issue during a transition (workflow action), by providing the issueKey and the transition id in actionDescriptorId. You can obtain the IDs of an issue's valid transitions using the transitions option in the expand parameter of Get issue.

In all these cases, you can pass an account ID to determine if a user can be assigned to an issue. The user is returned in the response if they can be assigned to the issue or issue transition.

This operation takes the users in the range defined by startAt and maxResults, up to the thousandth user, and then returns only the users from that range that can be assigned the issue. This means the operation usually returns fewer users than specified in maxResults. To get all the users who can be assigned the issue, use Get all users and filter the records in your code.

Permissions required: Permission to access Jira.

Request Params

Key	Datatype	Description
`query`	string	A query string that is matched against user attributes, such as `displayName`, and `emailAddress`, to find relevant users. The string can match the prefix of the attribute's value. For example, query=john matches a user with a `displayName` of John Smith and a user with an `emailAddress` of johnson@example.com. Required, unless `username` or `accountId` is specified.
`sessionId`	string	The sessionId of this request. SessionId is the same until the assignee is set.
`username`	string	This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
`accountId`	string	A query string that is matched exactly against user `accountId`. Required, unless `query` is specified.
`project`	string	The project ID or project key (case sensitive). Required, unless `issueKey` is specified.
`issueKey`	string	The key of the issue. Required, unless `project` is specified.
`startAt`	number	The index of the first item to return in a page of results (page offset).
`maxResults`	number	The maximum number of items to return. This operation may return less than the maximum number of items even if more are available. The operation fetches users up to the maximum and then, from the fetched users, returns only the users that can be assigned to the issue.
`actionDescriptorId`	string	The ID of the transition.
`recommend`	boolean

RESPONSES

status: OK

{&quot;self&quot;:&quot;https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g&quot;,&quot;key&quot;:&quot;&quot;,&quot;accountId&quot;:&quot;5b10a2844c20165700ede21g&quot;,&quot;name&quot;:&quot;&quot;,&quot;emailAddress&quot;:&quot;mia@example.com&quot;,&quot;avatarUrls&quot;:{&quot;48x48&quot;:&quot;https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48\u0026s=48&quot;,&quot;24x24&quot;:&quot;https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24\u0026s=24&quot;,&quot;16x16&quot;:&quot;https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16\u0026s=16&quot;,&quot;32x32&quot;:&quot;https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32\u0026s=32&quot;},&quot;displayName&quot;:&quot;Mia Krystof&quot;,&quot;active&quot;:true,&quot;timeZone&quot;:&quot;Australia/Sydney&quot;,&quot;groups&quot;:{&quot;size&quot;:3,&quot;items&quot;:[]},&quot;applicationRoles&quot;:{&quot;size&quot;:1,&quot;items&quot;:[]}}