Cloud

Jira Cloud platform / Reference / REST API v2

User search

This resource represents various ways to search for and find users. Use it to obtain list of users including users assignable to projects and issues, users with permissions, user lists for pickup fields, and user lists generated using structured queries. Note that the operations in this resource only return users found within the first 1000 users.

Operations

GET/rest/api/2/user/assignable/multiProjectSearch GET/rest/api/2/user/assignable/search GET/rest/api/2/user/permission/search GET/rest/api/2/user/picker GET/rest/api/2/user/search GET/rest/api/2/user/search/query GET/rest/api/2/user/search/query/key GET/rest/api/2/user/viewissue/search

GET

Find users assignable to projects

Returns a list of users who can be assigned issues in one or more projects. The list may be restricted to users whose attributes match a string.

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 issues in the projects. This means the operation usually returns fewer users than specified in maxResults. To get all the users who can be assigned issues in the projects, 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.

This operation can be accessed anonymously.

Permissions required: None.

Data Security Policy: Exempt from app access rules

Scopes

Connect app scope required: READ

OAuth 2.0 scopes required:

ClassicRECOMMENDED:read:jira-user

Granular:read:project:jira, read:user:jira, read:application-role:jira, read:avatar:jira, read:group:jira

Request

Query parameters

query

string

username

string

accountId

string

projectKeys

string

Required

startAt

integer

maxResults

integer

Responses

Returned if the request is successful.

application/json

array<User>

GET/rest/api/2/user/assignable/multiProjectSearch

Forge

curl

Node.js

Java

Python

PHP

// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";

const response = await api.asUser().requestJira(route`/rest/api/2/user/assignable/multiProjectSearch?query=query&projectKeys={projectKeys}`, {
  headers: {
    'Accept': 'application/json'
  }
});

console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());

200Response

[
  {
    "accountId": "5b10a2844c20165700ede21g",
    "accountType": "atlassian",
    "active": false,
    "avatarUrls": {
      "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
      "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
      "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
      "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
    },
    "displayName": "Mia Krystof",
    "key": "",
    "name": "",
    "self": "https://your-domain.atlassian.net/rest/api/2/user?accountId=5b10a2844c20165700ede21g"
  },
  {
    "accountId": "5b10ac8d82e05b22cc7d4ef5",
    "accountType": "atlassian",
    "active": false,
    "avatarUrls": {
      "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=16&s=16",
      "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=24&s=24",
      "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=32&s=32",
      "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=48&s=48"
    },
    "displayName": "Emma Richards",
    "key": "",
    "name": "",
    "self": "https://your-domain.atlassian.net/rest/api/2/user?accountId=5b10ac8d82e05b22cc7d4ef5"
  }
]

GET

Find users assignable to issues

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: Browse users and groups global permission or Assign issues project permission

Data Security Policy: Not exempt from app access rules

Scopes

Connect app scope required: READ

OAuth 2.0 scopes required:

ClassicRECOMMENDED:read:jira-user

Granular:read:issue:jira, read:project:jira, read:user:jira, read:application-role:jira, read:avatar:jira ...(Show more)

Request

Query parameters

query

string

sessionId

string

username

string

accountId

string

project

string

issueKey

string

startAt

integer

maxResults

integer

actionDescriptorId

integer

recommend

boolean

Responses

Returned if the request is successful.

application/json

array<User>

GET/rest/api/2/user/assignable/search

Forge

curl

Node.js

Java

Python

PHP

// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";

const response = await api.asUser().requestJira(route`/rest/api/2/user/assignable/search?query=query`, {
  headers: {
    'Accept': 'application/json'
  }
});

console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());

200Response

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

GET

Find users with permissions

Returns a list of users who fulfill these criteria:

their user attributes match a search string.
they have a set of permissions for a project or issue.

If no search string is provided, a list of all users with the permissions is returned.

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 match the search string and have permission for the project or issue. This means the operation usually returns fewer users than specified in maxResults. To get all the users who match the search string and have permission for the project or issue, use Get all users and filter the records in your code.

This operation can be accessed anonymously.

Permissions required:

Administer Jira global permission, to get users for any project.
Administer Projects project permission for a project, to get users for that project.

Data Security Policy: Not exempt from app access rules

Scopes

Connect app scope required: READ

OAuth 2.0 scopes required:

ClassicRECOMMENDED:read:jira-user

Granular:read:issue:jira, read:project:jira, read:user:jira, read:application-role:jira, read:avatar:jira ...(Show more)

Request

Query parameters

query

string

username

string

accountId

string

permissions

string

Required

issueKey

string

projectKey

string

startAt

integer

maxResults

integer

Responses

Returned if the request is successful.

application/json

array<User>

GET/rest/api/2/user/permission/search

Forge

curl

Node.js

Java

Python

PHP

// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";

const response = await api.asUser().requestJira(route`/rest/api/2/user/permission/search?query=query&permissions={permissions}`, {
  headers: {
    'Accept': 'application/json'
  }
});

console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());

200Response

[
  {
    "accountId": "5b10a2844c20165700ede21g",
    "accountType": "atlassian",
    "active": false,
    "avatarUrls": {
      "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
      "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
      "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
      "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
    },
    "displayName": "Mia Krystof",
    "key": "",
    "name": "",
    "self": "https://your-domain.atlassian.net/rest/api/2/user?accountId=5b10a2844c20165700ede21g"
  },
  {
    "accountId": "5b10ac8d82e05b22cc7d4ef5",
    "accountType": "atlassian",
    "active": false,
    "avatarUrls": {
      "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=16&s=16",
      "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=24&s=24",
      "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=32&s=32",
      "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=48&s=48"
    },
    "displayName": "Emma Richards",
    "key": "",
    "name": "",
    "self": "https://your-domain.atlassian.net/rest/api/2/user?accountId=5b10ac8d82e05b22cc7d4ef5"
  }
]

GET

Find users for picker

Returns a list of users whose attributes match the query term. The returned object includes the html field where the matched query term is highlighted with the HTML strong tag. A list of account IDs can be provided to exclude users from the results.

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

This operation can be accessed anonymously.

Permissions required: Browse users and groups global permission. Anonymous calls and calls by users without the required permission return search results for an exact name match only.

Data Security Policy: Exempt from app access rules

Scopes

Connect app scope required: READ

OAuth 2.0 scopes required:

ClassicRECOMMENDED:read:jira-user

Granular:read:user:jira

Request

Query parameters

query

string

Required

maxResults

integer

showAvatar

boolean

exclude

array<string>

excludeAccountIds

array<string>

avatarSize

string

excludeConnectUsers

boolean

Responses

Returned if the request is successful.

application/json

FoundUsers

The list of users found in a search, including header text (Showing X of Y matching users) and total of matched users.

GET/rest/api/2/user/picker

Forge

curl

Node.js

Java

Python

PHP

// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";

const response = await api.asUser().requestJira(route`/rest/api/2/user/picker?query={query}`, {
  headers: {
    'Accept': 'application/json'
  }
});

console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());

200Response

{
  "header": "Showing 20 of 25 matching groups",
  "total": 25,
  "users": [
    {
      "accountId": "5b10a2844c20165700ede21g",
      "accountType": "atlassian",
      "avatarUrl": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
      "displayName": "Mia Krystof",
      "html": "<strong>Mi</strong>a Krystof - <strong>mi</strong>a@example.com (<strong>mi</strong>a)",
      "key": "mia",
      "name": "mia"
    }
  ]
}

GET

Find users

Returns a list of active users that match the search string and property.

This operation first applies a filter to match the search string and property, and then takes the filtered users in the range defined by startAt and maxResults, up to the thousandth user. To get all the users who match the search string and property, use Get all users and filter the records in your code.

This operation can be accessed anonymously.

Permissions required: Browse users and groups global permission. Anonymous calls or calls by users without the required permission return empty search results.

Data Security Policy: Exempt from app access rules

Scopes

Connect app scope required: READ

OAuth 2.0 scopes required:

ClassicRECOMMENDED:read:jira-user

Granular:read:user:jira, read:user.property:jira, read:application-role:jira, read:avatar:jira, read:group:jira

Request

Query parameters

query

string

username

string

accountId

string

startAt

integer

maxResults

integer

property

string

Responses

Returned if the request is successful.

application/json

array<User>

GET/rest/api/2/user/search

Forge

curl

Node.js

Java

Python

PHP

// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";

const response = await api.asUser().requestJira(route`/rest/api/2/user/search?query=query`, {
  headers: {
    'Accept': 'application/json'
  }
});

console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());

200Response

[
  {
    "accountId": "5b10a2844c20165700ede21g",
    "accountType": "atlassian",
    "active": false,
    "avatarUrls": {
      "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
      "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
      "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
      "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
    },
    "displayName": "Mia Krystof",
    "key": "",
    "name": "",
    "self": "https://your-domain.atlassian.net/rest/api/2/user?accountId=5b10a2844c20165700ede21g"
  },
  {
    "accountId": "5b10ac8d82e05b22cc7d4ef5",
    "accountType": "atlassian",
    "active": false,
    "avatarUrls": {
      "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=16&s=16",
      "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=24&s=24",
      "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=32&s=32",
      "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=48&s=48"
    },
    "displayName": "Emma Richards",
    "key": "",
    "name": "",
    "self": "https://your-domain.atlassian.net/rest/api/2/user?accountId=5b10ac8d82e05b22cc7d4ef5"
  }
]

GET

Find users by query

Finds users with a structured query and returns a paginated list of user details.

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 match the structured query. This means the operation usually returns fewer users than specified in maxResults. To get all the users who match the structured query, use Get all users and filter the records in your code.

Permissions required: Browse users and groups global permission.

The query statements are:

is assignee of PROJ Returns the users that are assignees of at least one issue in project PROJ.
is assignee of (PROJ-1, PROJ-2) Returns users that are assignees on the issues PROJ-1 or PROJ-2.
is reporter of (PROJ-1, PROJ-2) Returns users that are reporters on the issues PROJ-1 or PROJ-2.
is watcher of (PROJ-1, PROJ-2) Returns users that are watchers on the issues PROJ-1 or PROJ-2.
is voter of (PROJ-1, PROJ-2) Returns users that are voters on the issues PROJ-1 or PROJ-2.
is commenter of (PROJ-1, PROJ-2) Returns users that have posted a comment on the issues PROJ-1 or PROJ-2.
is transitioner of (PROJ-1, PROJ-2) Returns users that have performed a transition on issues PROJ-1 or PROJ-2.
[propertyKey].entity.property.path is "property value" Returns users with the entity property value.

The list of issues can be extended as needed, as in (PROJ-1, PROJ-2, ... PROJ-n). Statements can be combined using the AND and OR operators to form more complex queries. For example:

is assignee of PROJ AND [propertyKey].entity.property.path is "property value"

Data Security Policy: Not exempt from app access rules

Scopes

Connect app scope required: READ

OAuth 2.0 scopes required:

ClassicRECOMMENDED:read:jira-user

Granular:read:comment:jira, read:issue:jira, read:issue.vote:jira, read:issue.watcher:jira, read:project:jira ...(Show more)

Request

Query parameters

query

string

Required

startAt

integer

maxResults

integer

Responses

Returned if the request is successful.

application/json

PageBeanUser

A page of items.

GET/rest/api/2/user/search/query

Forge

curl

Node.js

Java

Python

PHP

// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";

const response = await api.asUser().requestJira(route`/rest/api/2/user/search/query?query={query}`, {
  headers: {
    'Accept': 'application/json'
  }
});

console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());

200Response

{
  "isLast": true,
  "maxResults": 51,
  "nextPage": "<string>",
  "self": "<string>",
  "startAt": 37,
  "total": 29,
  "values": [
    {
      "accountId": "<string>",
      "accountType": "atlassian",
      "active": true,
      "applicationRoles": {
        "callback": {},
        "items": [
          {}
        ],
        "max-results": 2154,
        "pagingCallback": {},
        "size": 2154
      },
      "avatarUrls": {
        "16x16": "<string>",
        "24x24": "<string>",
        "32x32": "<string>",
        "48x48": "<string>"
      },
      "displayName": "<string>",
      "emailAddress": "<string>",
      "expand": "<string>",
      "groups": {
        "callback": {},
        "items": [
          {}
        ],
        "max-results": 2154,
        "pagingCallback": {},
        "size": 2154
      },
      "key": "<string>",
      "locale": "<string>",
      "name": "<string>",
      "self": "<string>",
      "timeZone": "<string>"
    }
  ]
}

GET

Find user keys by query

Finds users with a structured query and returns a paginated list of user keys.

Permissions required: Browse users and groups global permission.

The query statements are:

is assignee of PROJ Returns the users that are assignees of at least one issue in project PROJ.
is assignee of (PROJ-1, PROJ-2) Returns users that are assignees on the issues PROJ-1 or PROJ-2.
is reporter of (PROJ-1, PROJ-2) Returns users that are reporters on the issues PROJ-1 or PROJ-2.
is watcher of (PROJ-1, PROJ-2) Returns users that are watchers on the issues PROJ-1 or PROJ-2.
is voter of (PROJ-1, PROJ-2) Returns users that are voters on the issues PROJ-1 or PROJ-2.
is commenter of (PROJ-1, PROJ-2) Returns users that have posted a comment on the issues PROJ-1 or PROJ-2.
is transitioner of (PROJ-1, PROJ-2) Returns users that have performed a transition on issues PROJ-1 or PROJ-2.
[propertyKey].entity.property.path is "property value" Returns users with the entity property value.

The list of issues can be extended as needed, as in (PROJ-1, PROJ-2, ... PROJ-n). Statements can be combined using the AND and OR operators to form more complex queries. For example:

is assignee of PROJ AND [propertyKey].entity.property.path is "property value"

Data Security Policy: Exempt from app access rules

Scopes

Connect app scope required: READ

OAuth 2.0 scopes required:

ClassicRECOMMENDED:read:jira-user

Granular:read:comment:jira, read:issue:jira, read:issue.vote:jira, read:issue.watcher:jira, read:project:jira ...(Show more)

Request

Query parameters

query

string

Required

startAt

integer

maxResult

integer

Responses

Returned if the request is successful.

application/json

PageBeanUserKey

A page of items.

GET/rest/api/2/user/search/query/key

Forge

curl

Node.js

Java

Python

PHP

// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";

const response = await api.asUser().requestJira(route`/rest/api/2/user/search/query/key?query={query}`, {
  headers: {
    'Accept': 'application/json'
  }
});

console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());

200Response

{
  "isLast": true,
  "maxResults": 51,
  "nextPage": "<string>",
  "self": "<string>",
  "startAt": 37,
  "total": 29,
  "values": [
    {
      "accountId": "<string>",
      "key": "<string>"
    }
  ]
}

GET

Find users with browse permission

Returns a list of users who fulfill these criteria:

their user attributes match a search string.
they have permission to browse issues.

Use this resource to find users who can browse:

an issue, by providing the issueKey.
any issue in a project, by providing the projectKey.

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 match the search string and have permission to browse issues. This means the operation usually returns fewer users than specified in maxResults. To get all the users who match the search string and have permission to browse issues, use Get all users and filter the records in your code.

This operation can be accessed anonymously.

Permissions required: Browse users and groups global permission. Anonymous calls and calls by users without the required permission return empty search results.

Data Security Policy: Not exempt from app access rules

Scopes

Connect app scope required: READ

OAuth 2.0 scopes required:

ClassicRECOMMENDED:read:jira-user

Granular:read:issue:jira, read:project:jira, read:user:jira, read:application-role:jira, read:avatar:jira ...(Show more)

Request

Query parameters

query

string

username

string

accountId

string

issueKey

string

projectKey

string

startAt

integer

maxResults

integer

Responses

Returned if the request is successful.

application/json

array<User>

GET/rest/api/2/user/viewissue/search

Forge

curl

Node.js

Java

Python

PHP

// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";

const response = await api.asUser().requestJira(route`/rest/api/2/user/viewissue/search?query=query`, {
  headers: {
    'Accept': 'application/json'
  }
});

console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());

200Response

[
  {
    "accountId": "5b10a2844c20165700ede21g",
    "accountType": "atlassian",
    "active": false,
    "avatarUrls": {
      "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
      "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
      "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
      "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
    },
    "displayName": "Mia Krystof",
    "key": "",
    "name": "",
    "self": "https://your-domain.atlassian.net/rest/api/2/user?accountId=5b10a2844c20165700ede21g"
  },
  {
    "accountId": "5b10ac8d82e05b22cc7d4ef5",
    "accountType": "atlassian",
    "active": false,
    "avatarUrls": {
      "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=16&s=16",
      "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=24&s=24",
      "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=32&s=32",
      "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=48&s=48"
    },
    "displayName": "Emma Richards",
    "key": "",
    "name": "",
    "self": "https://your-domain.atlassian.net/rest/api/2/user?accountId=5b10ac8d82e05b22cc7d4ef5"
  }
]