Find users assignable to issues

GET

/rest/api/3/user/assignable/search

User search

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.

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

Permissions required: Permission to access Jira.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'http://jira.local:8080/jira/rest//rest/api/3/user/assignable/search'

Response Example

200 - Success

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

Request

Query Params

query

string

optional

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

optional

The sessionId of this request. SessionId is the same until the assignee is set.

username

string

optional

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

accountId

string

optional

A query string that is matched exactly against user accountId. Required, unless query is specified.

project

string

optional

The project ID or project key (case sensitive). Required, unless issueKey is specified.

issueKey

string

optional

The key of the issue. Required, unless project is specified.

startAt

integer

optional

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

maxResults

integer

optional

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

integer

optional

The ID of the transition.

recommend

string

optional

Responses

🟢200Returned if the request is successful.

application/json

Body

array of:

🟠400Returned if: * `issueKey` or `project` is missing. * `query` or `accountId` is missing. * `query` and `accountId` are provided.

🟠401Returned if the authentication credentials are incorrect or missing.

🟠404Returned if the project, issue, or transition is not found.

🟠429Returned if the rate limit is exceeded. User search endpoints share a collective rate limit for the tenant, in addition to Jira's normal rate limiting you may receive a rate limit for user search. Please respect the Retry-After header.

Modified at 2023-07-13 03:27:27

Find users assignable to projects

Find users with permissions