{ "info": { "_postman_id": "7965705b-3528-4f48-b367-085001a9e5a8", "name": "Atlassian rest/api/3/user/", "description": "Needs description.\n\nContact Support:\n Email: ecosystem@atlassian.com", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-06-05T15:08:56.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "lastUpdatedBy": "35240", "uid": "35240-7965705b-3528-4f48-b367-085001a9e5a8" }, "item": [ { "name": "rest", "item": [ { "name": "api", "item": [ { "name": "3", "item": [ { "name": "user", "item": [ { "name": "assignable", "item": [ { "name": "multiProjectSearch", "item": [ { "name": "Atlassian Find Users Assignable To Projects", "id": "22b2693a-3f7e-4ed0-8ca4-523d8ec13b05", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rest/api/3/user/assignable/multiProjectSearch?query=&username=&accountId=&projectKeys=&startAt=0&maxResults=50", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "assignable", "multiProjectSearch" ], "query": [ { "description": "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 `accountId` is specified.", "key": "query", "value": "" }, { "description": "This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", "key": "username", "value": "" }, { "description": "A query string that is matched exactly against user `accountId`. Required, unless `query` is specified.", "key": "accountId", "value": "" }, { "description": "(Required) A list of project keys (case sensitive). This parameter accepts a comma-separated list.", "key": "projectKeys", "value": "" }, { "description": "The index of the first item to return in a page of results (page offset).", "key": "startAt", "value": "0" }, { "description": "The maximum number of items to return per page.", "key": "maxResults", "value": "50" } ] }, "description": "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](#api-rest-api-3-users-search-get) 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](https://developer.atlassian.com/cloud/jira/platform/profile-visibility/) for more details.

This operation can be accessed anonymously.

**[Permissions](#permissions) required:** None." }, "response": [ { "id": "d362c941-ba90-4e92-bcf7-81678c033e01", "name": "Returned if the request is successful.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rest/api/3/user/assignable/multiProjectSearch?query=&username=&accountId=&projectKeys=&startAt=0&maxResults=50", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "assignable", "multiProjectSearch" ], "query": [ { "description": "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 `accountId` is specified.", "key": "query", "value": "" }, { "description": "This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", "key": "username", "value": "" }, { "description": "A query string that is matched exactly against user `accountId`. Required, unless `query` is specified.", "key": "accountId", "value": "" }, { "description": "(Required) A list of project keys (case sensitive). This parameter accepts a comma-separated list.", "key": "projectKeys", "value": "" }, { "description": "The index of the first item to return in a page of results (page offset).", "key": "startAt", "value": "0" }, { "description": "The maximum number of items to return per page.", "key": "maxResults", "value": "50" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"value\": \"reference #/components/schemas/User not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/User not found in the OpenAPI spec\"\n }\n]", "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-d362c941-ba90-4e92-bcf7-81678c033e01" }, { "id": "d26785fe-1e13-4540-a36d-5852fc372352", "name": "Returned if:\n\n * `projectKeys` is missing.\n * `query` or `accountId` is missing.\n * `query` and `accountId` are provided.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/rest/api/3/user/assignable/multiProjectSearch?query=&username=&accountId=&projectKeys=&startAt=0&maxResults=50", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "assignable", "multiProjectSearch" ], "query": [ { "description": "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 `accountId` is specified.", "key": "query", "value": "" }, { "description": "This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", "key": "username", "value": "" }, { "description": "A query string that is matched exactly against user `accountId`. Required, unless `query` is specified.", "key": "accountId", "value": "" }, { "description": "(Required) A list of project keys (case sensitive). This parameter accepts a comma-separated list.", "key": "projectKeys", "value": "" }, { "description": "The index of the first item to return in a page of results (page offset).", "key": "startAt", "value": "0" }, { "description": "The maximum number of items to return per page.", "key": "maxResults", "value": "50" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-d26785fe-1e13-4540-a36d-5852fc372352" }, { "id": "00b4aba3-80a9-4abc-99c3-a1d81172ba39", "name": "Returned if the authentication credentials are incorrect or missing.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/rest/api/3/user/assignable/multiProjectSearch?query=&username=&accountId=&projectKeys=&startAt=0&maxResults=50", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "assignable", "multiProjectSearch" ], "query": [ { "description": "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 `accountId` is specified.", "key": "query", "value": "" }, { "description": "This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", "key": "username", "value": "" }, { "description": "A query string that is matched exactly against user `accountId`. Required, unless `query` is specified.", "key": "accountId", "value": "" }, { "description": "(Required) A list of project keys (case sensitive). This parameter accepts a comma-separated list.", "key": "projectKeys", "value": "" }, { "description": "The index of the first item to return in a page of results (page offset).", "key": "startAt", "value": "0" }, { "description": "The maximum number of items to return per page.", "key": "maxResults", "value": "50" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-00b4aba3-80a9-4abc-99c3-a1d81172ba39" }, { "id": "5220e12a-3ec8-42fb-b107-95379327104b", "name": "Returned if one or more of the projects is not found.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/rest/api/3/user/assignable/multiProjectSearch?query=&username=&accountId=&projectKeys=&startAt=0&maxResults=50", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "assignable", "multiProjectSearch" ], "query": [ { "description": "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 `accountId` is specified.", "key": "query", "value": "" }, { "description": "This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", "key": "username", "value": "" }, { "description": "A query string that is matched exactly against user `accountId`. Required, unless `query` is specified.", "key": "accountId", "value": "" }, { "description": "(Required) A list of project keys (case sensitive). This parameter accepts a comma-separated list.", "key": "projectKeys", "value": "" }, { "description": "The index of the first item to return in a page of results (page offset).", "key": "startAt", "value": "0" }, { "description": "The maximum number of items to return per page.", "key": "maxResults", "value": "50" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-5220e12a-3ec8-42fb-b107-95379327104b" }, { "id": "c6bd9f89-5895-4a2d-9169-b0d3d98c60d1", "name": "Returned 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.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/rest/api/3/user/assignable/multiProjectSearch?query=&username=&accountId=&projectKeys=&startAt=0&maxResults=50", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "assignable", "multiProjectSearch" ], "query": [ { "description": "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 `accountId` is specified.", "key": "query", "value": "" }, { "description": "This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", "key": "username", "value": "" }, { "description": "A query string that is matched exactly against user `accountId`. Required, unless `query` is specified.", "key": "accountId", "value": "" }, { "description": "(Required) A list of project keys (case sensitive). This parameter accepts a comma-separated list.", "key": "projectKeys", "value": "" }, { "description": "The index of the first item to return in a page of results (page offset).", "key": "startAt", "value": "0" }, { "description": "The maximum number of items to return per page.", "key": "maxResults", "value": "50" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-c6bd9f89-5895-4a2d-9169-b0d3d98c60d1" } ], "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-22b2693a-3f7e-4ed0-8ca4-523d8ec13b05" } ], "id": "fe0cc808-e95b-4a78-9c9b-cca9f5882678", "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-fe0cc808-e95b-4a78-9c9b-cca9f5882678" }, { "name": "search", "item": [ { "name": "Atlassian Find Users Assignable To Issues", "id": "3426a42c-ba07-481e-8a2b-25939d66eaf7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rest/api/3/user/assignable/search?query=&sessionId=&username=&accountId=&project=&issueKey=&startAt=0&maxResults=50&actionDescriptorId=&recommend=false", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "assignable", "search" ], "query": [ { "description": "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.", "key": "query", "value": "" }, { "description": "The sessionId of this request. SessionId is the same until the assignee is set.", "key": "sessionId", "value": "" }, { "description": "This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", "key": "username", "value": "" }, { "description": "A query string that is matched exactly against user `accountId`. Required, unless `query` is specified.", "key": "accountId", "value": "" }, { "description": "The project ID or project key (case sensitive). Required, unless `issueKey` is specified.", "key": "project", "value": "" }, { "description": "The key of the issue. Required, unless `project` is specified.", "key": "issueKey", "value": "" }, { "description": "The index of the first item to return in a page of results (page offset).", "key": "startAt", "value": "0" }, { "description": "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.", "key": "maxResults", "value": "50" }, { "description": "The ID of the transition.", "key": "actionDescriptorId", "value": "" }, { "key": "recommend", "value": "false" } ] }, "description": "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](#api-rest-api-3-issue-issueIdOrKey-get).

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](#api-rest-api-3-users-search-get) 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](https://developer.atlassian.com/cloud/jira/platform/profile-visibility/) for more details.

**[Permissions](#permissions) required:** *Browse users and groups* [global permission](https://confluence.atlassian.com/x/x4dKLg) or *Assign issues* [project permission](https://confluence.atlassian.com/x/yodKLg)" }, "response": [ { "id": "c5fa8bb8-d540-4196-9332-69c9096d02b7", "name": "Returned if the request is successful.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rest/api/3/user/assignable/search?query=&sessionId=&username=&accountId=&project=&issueKey=&startAt=0&maxResults=50&actionDescriptorId=&recommend=false", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "assignable", "search" ], "query": [ { "description": "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.", "key": "query", "value": "" }, { "description": "The sessionId of this request. SessionId is the same until the assignee is set.", "key": "sessionId", "value": "" }, { "description": "This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", "key": "username", "value": "" }, { "description": "A query string that is matched exactly against user `accountId`. Required, unless `query` is specified.", "key": "accountId", "value": "" }, { "description": "The project ID or project key (case sensitive). Required, unless `issueKey` is specified.", "key": "project", "value": "" }, { "description": "The key of the issue. Required, unless `project` is specified.", "key": "issueKey", "value": "" }, { "description": "The index of the first item to return in a page of results (page offset).", "key": "startAt", "value": "0" }, { "description": "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.", "key": "maxResults", "value": "50" }, { "description": "The ID of the transition.", "key": "actionDescriptorId", "value": "" }, { "key": "recommend", "value": "false" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"value\": \"reference #/components/schemas/User not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/User not found in the OpenAPI spec\"\n }\n]", "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-c5fa8bb8-d540-4196-9332-69c9096d02b7" }, { "id": "5e91b0eb-ed6f-453f-90cd-197c158b8d54", "name": "Returned if:\n\n * `issueKey` or `project` is missing.\n * `query` or `accountId` is missing.\n * `query` and `accountId` are provided.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/rest/api/3/user/assignable/search?query=&sessionId=&username=&accountId=&project=&issueKey=&startAt=0&maxResults=50&actionDescriptorId=&recommend=false", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "assignable", "search" ], "query": [ { "description": "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.", "key": "query", "value": "" }, { "description": "The sessionId of this request. SessionId is the same until the assignee is set.", "key": "sessionId", "value": "" }, { "description": "This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", "key": "username", "value": "" }, { "description": "A query string that is matched exactly against user `accountId`. Required, unless `query` is specified.", "key": "accountId", "value": "" }, { "description": "The project ID or project key (case sensitive). Required, unless `issueKey` is specified.", "key": "project", "value": "" }, { "description": "The key of the issue. Required, unless `project` is specified.", "key": "issueKey", "value": "" }, { "description": "The index of the first item to return in a page of results (page offset).", "key": "startAt", "value": "0" }, { "description": "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.", "key": "maxResults", "value": "50" }, { "description": "The ID of the transition.", "key": "actionDescriptorId", "value": "" }, { "key": "recommend", "value": "false" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-5e91b0eb-ed6f-453f-90cd-197c158b8d54" }, { "id": "2a602ee2-a6e4-4096-95af-9e1db54b0ba0", "name": "Returned if the authentication credentials are incorrect or missing.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/rest/api/3/user/assignable/search?query=&sessionId=&username=&accountId=&project=&issueKey=&startAt=0&maxResults=50&actionDescriptorId=&recommend=false", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "assignable", "search" ], "query": [ { "description": "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.", "key": "query", "value": "" }, { "description": "The sessionId of this request. SessionId is the same until the assignee is set.", "key": "sessionId", "value": "" }, { "description": "This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", "key": "username", "value": "" }, { "description": "A query string that is matched exactly against user `accountId`. Required, unless `query` is specified.", "key": "accountId", "value": "" }, { "description": "The project ID or project key (case sensitive). Required, unless `issueKey` is specified.", "key": "project", "value": "" }, { "description": "The key of the issue. Required, unless `project` is specified.", "key": "issueKey", "value": "" }, { "description": "The index of the first item to return in a page of results (page offset).", "key": "startAt", "value": "0" }, { "description": "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.", "key": "maxResults", "value": "50" }, { "description": "The ID of the transition.", "key": "actionDescriptorId", "value": "" }, { "key": "recommend", "value": "false" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-2a602ee2-a6e4-4096-95af-9e1db54b0ba0" }, { "id": "1c136427-0cdf-4596-b119-23314cac7a84", "name": "Returned if the project, issue, or transition is not found.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/rest/api/3/user/assignable/search?query=&sessionId=&username=&accountId=&project=&issueKey=&startAt=0&maxResults=50&actionDescriptorId=&recommend=false", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "assignable", "search" ], "query": [ { "description": "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.", "key": "query", "value": "" }, { "description": "The sessionId of this request. SessionId is the same until the assignee is set.", "key": "sessionId", "value": "" }, { "description": "This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", "key": "username", "value": "" }, { "description": "A query string that is matched exactly against user `accountId`. Required, unless `query` is specified.", "key": "accountId", "value": "" }, { "description": "The project ID or project key (case sensitive). Required, unless `issueKey` is specified.", "key": "project", "value": "" }, { "description": "The key of the issue. Required, unless `project` is specified.", "key": "issueKey", "value": "" }, { "description": "The index of the first item to return in a page of results (page offset).", "key": "startAt", "value": "0" }, { "description": "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.", "key": "maxResults", "value": "50" }, { "description": "The ID of the transition.", "key": "actionDescriptorId", "value": "" }, { "key": "recommend", "value": "false" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-1c136427-0cdf-4596-b119-23314cac7a84" }, { "id": "b1ea476d-089e-4be2-bb6a-b269fa0e68ac", "name": "Returned 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.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/rest/api/3/user/assignable/search?query=&sessionId=&username=&accountId=&project=&issueKey=&startAt=0&maxResults=50&actionDescriptorId=&recommend=false", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "assignable", "search" ], "query": [ { "description": "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.", "key": "query", "value": "" }, { "description": "The sessionId of this request. SessionId is the same until the assignee is set.", "key": "sessionId", "value": "" }, { "description": "This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", "key": "username", "value": "" }, { "description": "A query string that is matched exactly against user `accountId`. Required, unless `query` is specified.", "key": "accountId", "value": "" }, { "description": "The project ID or project key (case sensitive). Required, unless `issueKey` is specified.", "key": "project", "value": "" }, { "description": "The key of the issue. Required, unless `project` is specified.", "key": "issueKey", "value": "" }, { "description": "The index of the first item to return in a page of results (page offset).", "key": "startAt", "value": "0" }, { "description": "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.", "key": "maxResults", "value": "50" }, { "description": "The ID of the transition.", "key": "actionDescriptorId", "value": "" }, { "key": "recommend", "value": "false" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-b1ea476d-089e-4be2-bb6a-b269fa0e68ac" } ], "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-3426a42c-ba07-481e-8a2b-25939d66eaf7" } ], "id": "e5cb02ce-4d5d-4563-a872-b9cc429b9c57", "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-e5cb02ce-4d5d-4563-a872-b9cc429b9c57" } ], "id": "a4074279-b28e-4653-8e99-628e19b2a2c6", "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-a4074279-b28e-4653-8e99-628e19b2a2c6" }, { "name": "bulk", "item": [ { "name": "migration", "item": [ { "name": "Atlassian Get Account Ids For Users", "id": "c13e207b-462d-4a37-8172-742207185cc8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rest/api/3/user/bulk/migration?startAt=0&maxResults=10&username=&username=&key=&key=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "bulk", "migration" ], "query": [ { "description": "The index of the first item to return in a page of results (page offset).", "key": "startAt", "value": "0" }, { "description": "The maximum number of items to return per page.", "key": "maxResults", "value": "10" }, { "description": "Username of a user. To specify multiple users, pass multiple copies of this parameter. For example, `username=fred&username=barney`. Required if `key` isn't provided. Cannot be provided if `key` is present.", "key": "username", "value": "" }, { "description": "Username of a user. To specify multiple users, pass multiple copies of this parameter. For example, `username=fred&username=barney`. Required if `key` isn't provided. Cannot be provided if `key` is present.", "key": "username", "value": "" }, { "description": "Key of a user. To specify multiple users, pass multiple copies of this parameter. For example, `key=fred&key=barney`. Required if `username` isn't provided. Cannot be provided if `username` is present.", "key": "key", "value": "" }, { "description": "Key of a user. To specify multiple users, pass multiple copies of this parameter. For example, `key=fred&key=barney`. Required if `username` isn't provided. Cannot be provided if `username` is present.", "key": "key", "value": "" } ] }, "description": "Returns the account IDs for the users specified in the `key` or `username` parameters. Note that multiple `key` or `username` parameters can be specified.

**[Permissions](#permissions) required:** Permission to access Jira." }, "response": [ { "id": "8d9241fc-0a53-43b3-afcf-d435572de59b", "name": "Returned if the request is successful.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rest/api/3/user/bulk/migration?startAt=0&maxResults=10&username=&key=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "bulk", "migration" ], "query": [ { "description": "The index of the first item to return in a page of results (page offset).", "key": "startAt", "value": "0" }, { "description": "The maximum number of items to return per page.", "key": "maxResults", "value": "10" }, { "description": "Username of a user. To specify multiple users, pass multiple copies of this parameter. For example, `username=fred&username=barney`. Required if `key` isn't provided. Cannot be provided if `key` is present.", "key": "username", "value": "" }, { "description": "Key of a user. To specify multiple users, pass multiple copies of this parameter. For example, `key=fred&key=barney`. Required if `username` isn't provided. Cannot be provided if `username` is present.", "key": "key", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"value\": \"reference #/components/schemas/UserMigrationBean not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/UserMigrationBean not found in the OpenAPI spec\"\n }\n]", "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-8d9241fc-0a53-43b3-afcf-d435572de59b" }, { "id": "8d071b9d-672b-4122-80a3-8165f1a3a509", "name": "Returned if `key` or `username`", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/rest/api/3/user/bulk/migration?startAt=0&maxResults=10&username=&key=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "bulk", "migration" ], "query": [ { "description": "The index of the first item to return in a page of results (page offset).", "key": "startAt", "value": "0" }, { "description": "The maximum number of items to return per page.", "key": "maxResults", "value": "10" }, { "description": "Username of a user. To specify multiple users, pass multiple copies of this parameter. For example, `username=fred&username=barney`. Required if `key` isn't provided. Cannot be provided if `key` is present.", "key": "username", "value": "" }, { "description": "Key of a user. To specify multiple users, pass multiple copies of this parameter. For example, `key=fred&key=barney`. Required if `username` isn't provided. Cannot be provided if `username` is present.", "key": "key", "value": "" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-8d071b9d-672b-4122-80a3-8165f1a3a509" }, { "id": "fd0b30c9-69d2-4683-9b52-375effe272e7", "name": "Returned if the authentication credentials are incorrect or missing.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/rest/api/3/user/bulk/migration?startAt=0&maxResults=10&username=&key=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "bulk", "migration" ], "query": [ { "description": "The index of the first item to return in a page of results (page offset).", "key": "startAt", "value": "0" }, { "description": "The maximum number of items to return per page.", "key": "maxResults", "value": "10" }, { "description": "Username of a user. To specify multiple users, pass multiple copies of this parameter. For example, `username=fred&username=barney`. Required if `key` isn't provided. Cannot be provided if `key` is present.", "key": "username", "value": "" }, { "description": "Key of a user. To specify multiple users, pass multiple copies of this parameter. For example, `key=fred&key=barney`. Required if `username` isn't provided. Cannot be provided if `username` is present.", "key": "key", "value": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-fd0b30c9-69d2-4683-9b52-375effe272e7" } ], "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-c13e207b-462d-4a37-8172-742207185cc8" } ], "id": "89e34782-ff19-4a81-84c7-008eeda34e4a", "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-89e34782-ff19-4a81-84c7-008eeda34e4a" }, { "name": "Atlassian Bulk Get Users", "id": "2453b40b-3213-4485-b68e-2f67f171d27e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rest/api/3/user/bulk?startAt=0&maxResults=10&username=&username=&key=&key=&accountId=&accountId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "bulk" ], "query": [ { "description": "The index of the first item to return in a page of results (page offset).", "key": "startAt", "value": "0" }, { "description": "The maximum number of items to return per page.", "key": "maxResults", "value": "10" }, { "description": "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.", "key": "username", "value": "" }, { "description": "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.", "key": "username", "value": "" }, { "description": "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.", "key": "key", "value": "" }, { "description": "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.", "key": "key", "value": "" }, { "description": "(Required) The account ID of a user. To specify multiple users, pass multiple `accountId` parameters. For example, `accountId=5b10a2844c20165700ede21g&accountId=5b10ac8d82e05b22cc7d4ef5`.", "key": "accountId", "value": "" }, { "description": "(Required) The account ID of a user. To specify multiple users, pass multiple `accountId` parameters. For example, `accountId=5b10a2844c20165700ede21g&accountId=5b10ac8d82e05b22cc7d4ef5`.", "key": "accountId", "value": "" } ] }, "description": "Returns a [paginated](#pagination) list of the users specified by one or more account IDs.

**[Permissions](#permissions) required:** Permission to access Jira." }, "response": [ { "id": "1d25f7e2-21af-4a99-adf6-fab2f6dae2a9", "name": "Returned if the request is successful.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rest/api/3/user/bulk?startAt=0&maxResults=10&username=&key=&accountId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "bulk" ], "query": [ { "description": "The index of the first item to return in a page of results (page offset).", "key": "startAt", "value": "0" }, { "description": "The maximum number of items to return per page.", "key": "maxResults", "value": "10" }, { "description": "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.", "key": "username", "value": "" }, { "description": "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.", "key": "key", "value": "" }, { "description": "(Required) The account ID of a user. To specify multiple users, pass multiple `accountId` parameters. For example, `accountId=5b10a2844c20165700ede21g&accountId=5b10ac8d82e05b22cc7d4ef5`.", "key": "accountId", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"isLast\": \"\",\n \"maxResults\": \"\",\n \"nextPage\": \"\",\n \"self\": \"\",\n \"startAt\": \"\",\n \"total\": \"\",\n \"values\": [\n {\n \"value\": \"reference #/components/schemas/User not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/User not found in the OpenAPI spec\"\n }\n ]\n}", "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-1d25f7e2-21af-4a99-adf6-fab2f6dae2a9" }, { "id": "af5069ce-56b1-49e7-9a98-6dc7cad1cdd1", "name": "Returned if `accountID` is missing.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/rest/api/3/user/bulk?startAt=0&maxResults=10&username=&key=&accountId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "bulk" ], "query": [ { "description": "The index of the first item to return in a page of results (page offset).", "key": "startAt", "value": "0" }, { "description": "The maximum number of items to return per page.", "key": "maxResults", "value": "10" }, { "description": "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.", "key": "username", "value": "" }, { "description": "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.", "key": "key", "value": "" }, { "description": "(Required) The account ID of a user. To specify multiple users, pass multiple `accountId` parameters. For example, `accountId=5b10a2844c20165700ede21g&accountId=5b10ac8d82e05b22cc7d4ef5`.", "key": "accountId", "value": "" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-af5069ce-56b1-49e7-9a98-6dc7cad1cdd1" }, { "id": "86d2c479-4737-4f28-a7d8-a953e75bf9a7", "name": "Returned if the authentication credentials are incorrect or missing.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/rest/api/3/user/bulk?startAt=0&maxResults=10&username=&key=&accountId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "bulk" ], "query": [ { "description": "The index of the first item to return in a page of results (page offset).", "key": "startAt", "value": "0" }, { "description": "The maximum number of items to return per page.", "key": "maxResults", "value": "10" }, { "description": "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.", "key": "username", "value": "" }, { "description": "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.", "key": "key", "value": "" }, { "description": "(Required) The account ID of a user. To specify multiple users, pass multiple `accountId` parameters. For example, `accountId=5b10a2844c20165700ede21g&accountId=5b10ac8d82e05b22cc7d4ef5`.", "key": "accountId", "value": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-86d2c479-4737-4f28-a7d8-a953e75bf9a7" } ], "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-2453b40b-3213-4485-b68e-2f67f171d27e" } ], "id": "665bb7e6-c6df-4845-b757-3b7c63d976b1", "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-665bb7e6-c6df-4845-b757-3b7c63d976b1" }, { "name": "columns", "item": [ { "name": "Atlassian Reset User Default Columns", "id": "f7feba38-ad6d-447f-8a03-293f4456a935", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "noauth" }, "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/rest/api/3/user/columns?accountId=&username=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "columns" ], "query": [ { "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.", "key": "accountId", "value": "" }, { "description": "This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", "key": "username", "value": "" } ] }, "description": "Resets the default [ issue table columns](https://confluence.atlassian.com/x/XYdKLg) for the user to the system default. If `accountId` is not passed, the calling user's default columns are reset.

**[Permissions](#permissions) required:**

* *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg), to set the columns on any user.
* Permission to access Jira, to set the calling user's columns." }, "response": [ { "id": "e3a61d24-b1f8-4230-b71e-40274b25eb1d", "name": "Returned if the request is successful.", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/rest/api/3/user/columns?accountId=&username=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "columns" ], "query": [ { "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.", "key": "accountId", "value": "" }, { "description": "This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", "key": "username", "value": "" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-e3a61d24-b1f8-4230-b71e-40274b25eb1d" }, { "id": "d3241d7e-531a-4fb4-a2f4-8d9e510e36f1", "name": "Returned if the authentication credentials are incorrect or missing.", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/rest/api/3/user/columns?accountId=&username=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "columns" ], "query": [ { "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.", "key": "accountId", "value": "" }, { "description": "This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", "key": "username", "value": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-d3241d7e-531a-4fb4-a2f4-8d9e510e36f1" }, { "id": "1380baf8-2ee3-4860-b766-5a1d53455fe5", "name": "Returned if the user does not have the necessary permission or is not accessing their user record.", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/rest/api/3/user/columns?accountId=&username=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "columns" ], "query": [ { "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.", "key": "accountId", "value": "" }, { "description": "This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", "key": "username", "value": "" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-1380baf8-2ee3-4860-b766-5a1d53455fe5" } ], "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-f7feba38-ad6d-447f-8a03-293f4456a935" }, { "name": "Atlassian Get User Default Columns", "id": "3de49d4d-b1f6-4007-b597-5bd0200475ab", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rest/api/3/user/columns?accountId=&username=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "columns" ], "query": [ { "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.", "key": "accountId", "value": "" }, { "description": "This parameter is no longer available See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", "key": "username", "value": "" } ] }, "description": "Returns the default [issue table columns](https://confluence.atlassian.com/x/XYdKLg) for the user. If `accountId` is not passed in the request, the calling user's details are returned.

**[Permissions](#permissions) required:**

* *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLgl), to get the column details for any user.
* Permission to access Jira, to get the calling user's column details." }, "response": [ { "id": "a144dc1d-83de-4833-a611-71d0f3969633", "name": "Returned if the request is successful.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rest/api/3/user/columns?accountId=&username=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "columns" ], "query": [ { "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.", "key": "accountId", "value": "" }, { "description": "This parameter is no longer available See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", "key": "username", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"value\": \"reference #/components/schemas/ColumnItem not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/ColumnItem not found in the OpenAPI spec\"\n }\n]", "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-a144dc1d-83de-4833-a611-71d0f3969633" }, { "id": "5023db8e-1bb7-4d66-a54a-53c329176021", "name": "Returned if the authentication credentials are incorrect or missing.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/rest/api/3/user/columns?accountId=&username=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "columns" ], "query": [ { "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.", "key": "accountId", "value": "" }, { "description": "This parameter is no longer available See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", "key": "username", "value": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-5023db8e-1bb7-4d66-a54a-53c329176021" }, { "id": "e0f1ed8c-57e2-448b-934b-f57a7d00a31f", "name": "Returned if the user does not have the necessary permission or is not accessing their user record.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/rest/api/3/user/columns?accountId=&username=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "columns" ], "query": [ { "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.", "key": "accountId", "value": "" }, { "description": "This parameter is no longer available See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", "key": "username", "value": "" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-e0f1ed8c-57e2-448b-934b-f57a7d00a31f" }, { "id": "92df3f4b-1144-4d63-851a-48c136f8fea2", "name": "Returned if the requested user is not found.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/rest/api/3/user/columns?accountId=&username=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "columns" ], "query": [ { "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.", "key": "accountId", "value": "" }, { "description": "This parameter is no longer available See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", "key": "username", "value": "" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-92df3f4b-1144-4d63-851a-48c136f8fea2" } ], "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-3de49d4d-b1f6-4007-b597-5bd0200475ab" }, { "name": "Atlassian Set User Default Columns", "id": "746db1cb-2cb0-465d-8f45-2e9181208d3e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "noauth" }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "*/*" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"value\": \"reference #/components/schemas/UserColumnRequestBody not found in the OpenAPI spec\"\n}" }, "url": { "raw": "{{baseUrl}}/rest/api/3/user/columns?accountId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "columns" ], "query": [ { "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.", "key": "accountId", "value": "" } ] }, "description": "Sets the default [ issue table columns](https://confluence.atlassian.com/x/XYdKLg) for the user. If an account ID is not passed, the calling user's default columns are set. If no column details are sent, then all default columns are removed.

The parameters for this resource are expressed as HTML form data. For example, in curl:

`curl -X PUT -d columns=summary -d columns=description https://your-domain.atlassian.net/rest/api/3/user/columns?accountId=5b10ac8d82e05b22cc7d4ef5'`

**[Permissions](#permissions) required:**

* *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg), to set the columns on any user.
* Permission to access Jira, to set the calling user's columns." }, "response": [ { "id": "333364ad-6471-4123-b1f4-085debcc7203", "name": "Returned if the request is successful.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "*/*" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"value\": \"reference #/components/schemas/UserColumnRequestBody not found in the OpenAPI spec\"\n}" }, "url": { "raw": "{{baseUrl}}/rest/api/3/user/columns?accountId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "columns" ], "query": [ { "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.", "key": "accountId", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-333364ad-6471-4123-b1f4-085debcc7203" }, { "id": "86b44d1e-3705-483b-8e5b-ea43ed3dc980", "name": "Returned if the authentication credentials are incorrect or missing.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": { "mode": "raw", "raw": "{\n \"value\": \"reference #/components/schemas/UserColumnRequestBody not found in the OpenAPI spec\"\n}" }, "url": { "raw": "{{baseUrl}}/rest/api/3/user/columns?accountId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "columns" ], "query": [ { "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.", "key": "accountId", "value": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-86b44d1e-3705-483b-8e5b-ea43ed3dc980" }, { "id": "58d4c2d3-25e1-4900-af87-ecf3bf2297e5", "name": "Returned if the user does not have the necessary permission or is not accessing their user record.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": { "mode": "raw", "raw": "{\n \"value\": \"reference #/components/schemas/UserColumnRequestBody not found in the OpenAPI spec\"\n}" }, "url": { "raw": "{{baseUrl}}/rest/api/3/user/columns?accountId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "columns" ], "query": [ { "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.", "key": "accountId", "value": "" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-58d4c2d3-25e1-4900-af87-ecf3bf2297e5" }, { "id": "602b4fd5-7e8f-4a47-8868-b1b310566f37", "name": "Returned if the requested user is not found.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": { "mode": "raw", "raw": "{\n \"value\": \"reference #/components/schemas/UserColumnRequestBody not found in the OpenAPI spec\"\n}" }, "url": { "raw": "{{baseUrl}}/rest/api/3/user/columns?accountId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "columns" ], "query": [ { "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.", "key": "accountId", "value": "" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-602b4fd5-7e8f-4a47-8868-b1b310566f37" }, { "id": "2c9455b1-3c06-44bd-9214-5dda4df22788", "name": "Returned 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.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": { "mode": "raw", "raw": "{\n \"value\": \"reference #/components/schemas/UserColumnRequestBody not found in the OpenAPI spec\"\n}" }, "url": { "raw": "{{baseUrl}}/rest/api/3/user/columns?accountId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "columns" ], "query": [ { "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.", "key": "accountId", "value": "" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-2c9455b1-3c06-44bd-9214-5dda4df22788" }, { "id": "2f4f0c89-8af6-4c81-a8c9-d4680b89a55f", "name": "Returned if an invalid issue table column ID is sent.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": { "mode": "raw", "raw": "{\n \"value\": \"reference #/components/schemas/UserColumnRequestBody not found in the OpenAPI spec\"\n}" }, "url": { "raw": "{{baseUrl}}/rest/api/3/user/columns?accountId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "columns" ], "query": [ { "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.", "key": "accountId", "value": "" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-2f4f0c89-8af6-4c81-a8c9-d4680b89a55f" } ], "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-746db1cb-2cb0-465d-8f45-2e9181208d3e" } ], "id": "e4130c6e-0b38-4db9-b8bc-da72abce610b", "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-e4130c6e-0b38-4db9-b8bc-da72abce610b" }, { "name": "email", "item": [ { "name": "bulk", "item": [ { "name": "Atlassian Get User Email Bulk", "id": "22b67cb7-d8c9-423c-8f7d-07232e2156ae", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rest/api/3/user/email/bulk?accountId=&accountId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "email", "bulk" ], "query": [ { "description": "(Required) The account IDs of the users for which emails are required. An `accountId` is an identifier that uniquely identifies the user across all Atlassian products. For example, `5b10ac8d82e05b22cc7d4ef5`. Note, this should be treated as an opaque identifier (that is, do not assume any structure in the value).", "key": "accountId", "value": "" }, { "description": "(Required) The account IDs of the users for which emails are required. An `accountId` is an identifier that uniquely identifies the user across all Atlassian products. For example, `5b10ac8d82e05b22cc7d4ef5`. Note, this should be treated as an opaque identifier (that is, do not assume any structure in the value).", "key": "accountId", "value": "" } ] }, "description": "Returns a user's email address. This API is only available to apps approved by Atlassian, according to these [guidelines](https://community.developer.atlassian.com/t/guidelines-for-requesting-access-to-email-address/27603)." }, "response": [ { "id": "d0945fa3-6d84-45d3-b735-f6e3ec4423f0", "name": "Returned if the request is successful.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rest/api/3/user/email/bulk?accountId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "email", "bulk" ], "query": [ { "description": "(Required) The account IDs of the users for which emails are required. An `accountId` is an identifier that uniquely identifies the user across all Atlassian products. For example, `5b10ac8d82e05b22cc7d4ef5`. Note, this should be treated as an opaque identifier (that is, do not assume any structure in the value).", "key": "accountId", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"accountId\": \"\",\n \"email\": \"\",\n \"dolor_4\": 13283374\n}", "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-d0945fa3-6d84-45d3-b735-f6e3ec4423f0" }, { "id": "2a54d737-48b7-4f50-afe0-c77b2b4841cb", "name": "Returned if the calling app is not approved to use this API.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/rest/api/3/user/email/bulk?accountId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "email", "bulk" ], "query": [ { "description": "(Required) The account IDs of the users for which emails are required. An `accountId` is an identifier that uniquely identifies the user across all Atlassian products. For example, `5b10ac8d82e05b22cc7d4ef5`. Note, this should be treated as an opaque identifier (that is, do not assume any structure in the value).", "key": "accountId", "value": "" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-2a54d737-48b7-4f50-afe0-c77b2b4841cb" }, { "id": "1e55059b-7792-4c55-9ac2-8c699f47d2b4", "name": "Returned if the authentication credentials are incorrect, or missing from the request (for example if a user is trying to access this API).", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/rest/api/3/user/email/bulk?accountId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "email", "bulk" ], "query": [ { "description": "(Required) The account IDs of the users for which emails are required. An `accountId` is an identifier that uniquely identifies the user across all Atlassian products. For example, `5b10ac8d82e05b22cc7d4ef5`. Note, this should be treated as an opaque identifier (that is, do not assume any structure in the value).", "key": "accountId", "value": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-1e55059b-7792-4c55-9ac2-8c699f47d2b4" }, { "id": "1d4dd429-1483-4c7f-9200-04b3126eef00", "name": "Indicates the API is not currently enabled.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/rest/api/3/user/email/bulk?accountId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "email", "bulk" ], "query": [ { "description": "(Required) The account IDs of the users for which emails are required. An `accountId` is an identifier that uniquely identifies the user across all Atlassian products. For example, `5b10ac8d82e05b22cc7d4ef5`. Note, this should be treated as an opaque identifier (that is, do not assume any structure in the value).", "key": "accountId", "value": "" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-1d4dd429-1483-4c7f-9200-04b3126eef00" } ], "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-22b67cb7-d8c9-423c-8f7d-07232e2156ae" } ], "id": "a12d5190-8850-4160-9888-5c5e0366c62f", "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-a12d5190-8850-4160-9888-5c5e0366c62f" }, { "name": "Atlassian Get User Email", "id": "806e6ec3-bfad-4d1c-9342-9ce37ec88cab", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rest/api/3/user/email?accountId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "email" ], "query": [ { "description": "(Required) The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, `5b10ac8d82e05b22cc7d4ef5`.", "key": "accountId", "value": "" } ] }, "description": "Returns a user's email address. This API is only available to apps approved by Atlassian, according to these [guidelines](https://community.developer.atlassian.com/t/guidelines-for-requesting-access-to-email-address/27603)." }, "response": [ { "id": "f5a301ae-76c7-41ba-a5db-d4c11107691c", "name": "Returned if the request is successful.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rest/api/3/user/email?accountId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "email" ], "query": [ { "description": "(Required) The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, `5b10ac8d82e05b22cc7d4ef5`.", "key": "accountId", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"accountId\": \"\",\n \"email\": \"\",\n \"dolor_4\": 13283374\n}", "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-f5a301ae-76c7-41ba-a5db-d4c11107691c" }, { "id": "d5167f45-9adf-44ba-8f3f-494f82d65c69", "name": "Returned if the calling app is not approved to use this API.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/rest/api/3/user/email?accountId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "email" ], "query": [ { "description": "(Required) The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, `5b10ac8d82e05b22cc7d4ef5`.", "key": "accountId", "value": "" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-d5167f45-9adf-44ba-8f3f-494f82d65c69" }, { "id": "ce37d64c-2ae3-4c2b-91b1-eeafe239ab32", "name": "Returned if the authentication credentials are incorrect or missing from the request (for example if a user is trying to access this API).", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/rest/api/3/user/email?accountId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "email" ], "query": [ { "description": "(Required) The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, `5b10ac8d82e05b22cc7d4ef5`.", "key": "accountId", "value": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-ce37d64c-2ae3-4c2b-91b1-eeafe239ab32" }, { "id": "7e9da727-f41f-4319-9175-407f1f95e4da", "name": "Returned if a user with the given `accountId` doesn't exist", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/rest/api/3/user/email?accountId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "email" ], "query": [ { "description": "(Required) The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, `5b10ac8d82e05b22cc7d4ef5`.", "key": "accountId", "value": "" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-7e9da727-f41f-4319-9175-407f1f95e4da" }, { "id": "f254e88f-fd7a-4f1f-bc57-dd0289dc90e5", "name": "Indicates the API is not currently enabled", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/rest/api/3/user/email?accountId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "email" ], "query": [ { "description": "(Required) The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, `5b10ac8d82e05b22cc7d4ef5`.", "key": "accountId", "value": "" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-f254e88f-fd7a-4f1f-bc57-dd0289dc90e5" } ], "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-806e6ec3-bfad-4d1c-9342-9ce37ec88cab" } ], "id": "a0878fec-f146-4c07-b3da-a4a7459cb316", "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-a0878fec-f146-4c07-b3da-a4a7459cb316" }, { "name": "groups", "item": [ { "name": "Atlassian Get User Groups", "id": "15bb54e6-f393-49d5-aa1a-28455484bb6d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rest/api/3/user/groups?accountId=&username=&key=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "groups" ], "query": [ { "description": "(Required) The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.", "key": "accountId", "value": "" }, { "description": "This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", "key": "username", "value": "" }, { "description": "This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", "key": "key", "value": "" } ] }, "description": "Returns the groups to which a user belongs.

**[Permissions](#permissions) required:** *Browse users and groups* [global permission](https://confluence.atlassian.com/x/x4dKLg)." }, "response": [ { "id": "c8caed84-07fe-43fb-984d-cbaaae910ce6", "name": "Returned if the request is successful.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rest/api/3/user/groups?accountId=&username=&key=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "groups" ], "query": [ { "description": "(Required) The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.", "key": "accountId", "value": "" }, { "description": "This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", "key": "username", "value": "" }, { "description": "This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", "key": "key", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"value\": \"reference #/components/schemas/GroupName not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/GroupName not found in the OpenAPI spec\"\n }\n]", "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-c8caed84-07fe-43fb-984d-cbaaae910ce6" }, { "id": "820c3777-1369-45d5-a004-7f4f1f187d2d", "name": "Returned if the authentication credentials are incorrect or missing.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/rest/api/3/user/groups?accountId=&username=&key=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "groups" ], "query": [ { "description": "(Required) The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.", "key": "accountId", "value": "" }, { "description": "This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", "key": "username", "value": "" }, { "description": "This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", "key": "key", "value": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-820c3777-1369-45d5-a004-7f4f1f187d2d" }, { "id": "2e07ad88-32d6-445c-b42e-08c53e6359d5", "name": "Returned if the calling user does not have the *Browse users and groups* global permission.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/rest/api/3/user/groups?accountId=&username=&key=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "groups" ], "query": [ { "description": "(Required) The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.", "key": "accountId", "value": "" }, { "description": "This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", "key": "username", "value": "" }, { "description": "This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", "key": "key", "value": "" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-2e07ad88-32d6-445c-b42e-08c53e6359d5" }, { "id": "240cb8d9-8f1a-4cd7-8930-36bcb997023c", "name": "Returned if the user is not found.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/rest/api/3/user/groups?accountId=&username=&key=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "groups" ], "query": [ { "description": "(Required) The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.", "key": "accountId", "value": "" }, { "description": "This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", "key": "username", "value": "" }, { "description": "This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", "key": "key", "value": "" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-240cb8d9-8f1a-4cd7-8930-36bcb997023c" } ], "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-15bb54e6-f393-49d5-aa1a-28455484bb6d" } ], "id": "c13c81cb-fca4-4d70-b768-c960bdc539ae", "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-c13c81cb-fca4-4d70-b768-c960bdc539ae" }, { "name": "permission", "item": [ { "name": "search", "item": [ { "name": "Atlassian Find Users With Permissions", "id": "4a82fb9f-6b64-425a-ae4b-8cbd6253edf7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rest/api/3/user/permission/search?query=&username=&accountId=&permissions=&issueKey=&projectKey=&startAt=0&maxResults=50", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "permission", "search" ], "query": [ { "description": "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 `accountId` is specified.", "key": "query", "value": "" }, { "description": "This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", "key": "username", "value": "" }, { "description": "A query string that is matched exactly against user `accountId`. Required, unless `query` is specified.", "key": "accountId", "value": "" }, { "description": "(Required) A comma separated list of permissions. Permissions can be specified as any:\n\n * permission returned by [Get all permissions](#api-rest-api-3-permissions-get).\n * custom project permission added by Connect apps.\n * (deprecated) one of the following:\n \n * ASSIGNABLE\\_USER\n * ASSIGN\\_ISSUE\n * ATTACHMENT\\_DELETE\\_ALL\n * ATTACHMENT\\_DELETE\\_OWN\n * BROWSE\n * CLOSE\\_ISSUE\n * COMMENT\\_DELETE\\_ALL\n * COMMENT\\_DELETE\\_OWN\n * COMMENT\\_EDIT\\_ALL\n * COMMENT\\_EDIT\\_OWN\n * COMMENT\\_ISSUE\n * CREATE\\_ATTACHMENT\n * CREATE\\_ISSUE\n * DELETE\\_ISSUE\n * EDIT\\_ISSUE\n * LINK\\_ISSUE\n * MANAGE\\_WATCHER\\_LIST\n * MODIFY\\_REPORTER\n * MOVE\\_ISSUE\n * PROJECT\\_ADMIN\n * RESOLVE\\_ISSUE\n * SCHEDULE\\_ISSUE\n * SET\\_ISSUE\\_SECURITY\n * TRANSITION\\_ISSUE\n * VIEW\\_VERSION\\_CONTROL\n * VIEW\\_VOTERS\\_AND\\_WATCHERS\n * VIEW\\_WORKFLOW\\_READONLY\n * WORKLOG\\_DELETE\\_ALL\n * WORKLOG\\_DELETE\\_OWN\n * WORKLOG\\_EDIT\\_ALL\n * WORKLOG\\_EDIT\\_OWN\n * WORK\\_ISSUE", "key": "permissions", "value": "" }, { "description": "The issue key for the issue.", "key": "issueKey", "value": "" }, { "description": "The project key for the project (case sensitive).", "key": "projectKey", "value": "" }, { "description": "The index of the first item to return in a page of results (page offset).", "key": "startAt", "value": "0" }, { "description": "The maximum number of items to return per page.", "key": "maxResults", "value": "50" } ] }, "description": "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](#api-rest-api-3-users-search-get) 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](https://developer.atlassian.com/cloud/jira/platform/profile-visibility/) for more details.

This operation can be accessed anonymously.

**[Permissions](#permissions) required:**

* *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg), to get users for any project.
* *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for a project, to get users for that project." }, "response": [ { "id": "c6c66498-6dc6-428a-b2c5-f4f403e520cf", "name": "Returned if the request is successful.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rest/api/3/user/permission/search?query=&username=&accountId=&permissions=&issueKey=&projectKey=&startAt=0&maxResults=50", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "permission", "search" ], "query": [ { "description": "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 `accountId` is specified.", "key": "query", "value": "" }, { "description": "This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", "key": "username", "value": "" }, { "description": "A query string that is matched exactly against user `accountId`. Required, unless `query` is specified.", "key": "accountId", "value": "" }, { "description": "(Required) A comma separated list of permissions. Permissions can be specified as any:\n\n * permission returned by [Get all permissions](#api-rest-api-3-permissions-get).\n * custom project permission added by Connect apps.\n * (deprecated) one of the following:\n \n * ASSIGNABLE\\_USER\n * ASSIGN\\_ISSUE\n * ATTACHMENT\\_DELETE\\_ALL\n * ATTACHMENT\\_DELETE\\_OWN\n * BROWSE\n * CLOSE\\_ISSUE\n * COMMENT\\_DELETE\\_ALL\n * COMMENT\\_DELETE\\_OWN\n * COMMENT\\_EDIT\\_ALL\n * COMMENT\\_EDIT\\_OWN\n * COMMENT\\_ISSUE\n * CREATE\\_ATTACHMENT\n * CREATE\\_ISSUE\n * DELETE\\_ISSUE\n * EDIT\\_ISSUE\n * LINK\\_ISSUE\n * MANAGE\\_WATCHER\\_LIST\n * MODIFY\\_REPORTER\n * MOVE\\_ISSUE\n * PROJECT\\_ADMIN\n * RESOLVE\\_ISSUE\n * SCHEDULE\\_ISSUE\n * SET\\_ISSUE\\_SECURITY\n * TRANSITION\\_ISSUE\n * VIEW\\_VERSION\\_CONTROL\n * VIEW\\_VOTERS\\_AND\\_WATCHERS\n * VIEW\\_WORKFLOW\\_READONLY\n * WORKLOG\\_DELETE\\_ALL\n * WORKLOG\\_DELETE\\_OWN\n * WORKLOG\\_EDIT\\_ALL\n * WORKLOG\\_EDIT\\_OWN\n * WORK\\_ISSUE", "key": "permissions", "value": "" }, { "description": "The issue key for the issue.", "key": "issueKey", "value": "" }, { "description": "The project key for the project (case sensitive).", "key": "projectKey", "value": "" }, { "description": "The index of the first item to return in a page of results (page offset).", "key": "startAt", "value": "0" }, { "description": "The maximum number of items to return per page.", "key": "maxResults", "value": "50" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"value\": \"reference #/components/schemas/User not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/User not found in the OpenAPI spec\"\n }\n]", "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-c6c66498-6dc6-428a-b2c5-f4f403e520cf" }, { "id": "bd02ad66-9e8c-452c-90b8-3830efa18aaf", "name": "Returned if:\n\n * `issueKey` or `projectKey` is missing.\n * `query` or `accountId` is missing.\n * `query` and `accountId` are provided.\n * `permissions` is empty or contains an invalid entry.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/rest/api/3/user/permission/search?query=&username=&accountId=&permissions=&issueKey=&projectKey=&startAt=0&maxResults=50", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "permission", "search" ], "query": [ { "description": "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 `accountId` is specified.", "key": "query", "value": "" }, { "description": "This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", "key": "username", "value": "" }, { "description": "A query string that is matched exactly against user `accountId`. Required, unless `query` is specified.", "key": "accountId", "value": "" }, { "description": "(Required) A comma separated list of permissions. Permissions can be specified as any:\n\n * permission returned by [Get all permissions](#api-rest-api-3-permissions-get).\n * custom project permission added by Connect apps.\n * (deprecated) one of the following:\n \n * ASSIGNABLE\\_USER\n * ASSIGN\\_ISSUE\n * ATTACHMENT\\_DELETE\\_ALL\n * ATTACHMENT\\_DELETE\\_OWN\n * BROWSE\n * CLOSE\\_ISSUE\n * COMMENT\\_DELETE\\_ALL\n * COMMENT\\_DELETE\\_OWN\n * COMMENT\\_EDIT\\_ALL\n * COMMENT\\_EDIT\\_OWN\n * COMMENT\\_ISSUE\n * CREATE\\_ATTACHMENT\n * CREATE\\_ISSUE\n * DELETE\\_ISSUE\n * EDIT\\_ISSUE\n * LINK\\_ISSUE\n * MANAGE\\_WATCHER\\_LIST\n * MODIFY\\_REPORTER\n * MOVE\\_ISSUE\n * PROJECT\\_ADMIN\n * RESOLVE\\_ISSUE\n * SCHEDULE\\_ISSUE\n * SET\\_ISSUE\\_SECURITY\n * TRANSITION\\_ISSUE\n * VIEW\\_VERSION\\_CONTROL\n * VIEW\\_VOTERS\\_AND\\_WATCHERS\n * VIEW\\_WORKFLOW\\_READONLY\n * WORKLOG\\_DELETE\\_ALL\n * WORKLOG\\_DELETE\\_OWN\n * WORKLOG\\_EDIT\\_ALL\n * WORKLOG\\_EDIT\\_OWN\n * WORK\\_ISSUE", "key": "permissions", "value": "" }, { "description": "The issue key for the issue.", "key": "issueKey", "value": "" }, { "description": "The project key for the project (case sensitive).", "key": "projectKey", "value": "" }, { "description": "The index of the first item to return in a page of results (page offset).", "key": "startAt", "value": "0" }, { "description": "The maximum number of items to return per page.", "key": "maxResults", "value": "50" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-bd02ad66-9e8c-452c-90b8-3830efa18aaf" }, { "id": "d353285f-9b27-4ded-8909-ca9e326907d9", "name": "Returned if the authentication credentials are incorrect or missing.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/rest/api/3/user/permission/search?query=&username=&accountId=&permissions=&issueKey=&projectKey=&startAt=0&maxResults=50", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "permission", "search" ], "query": [ { "description": "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 `accountId` is specified.", "key": "query", "value": "" }, { "description": "This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", "key": "username", "value": "" }, { "description": "A query string that is matched exactly against user `accountId`. Required, unless `query` is specified.", "key": "accountId", "value": "" }, { "description": "(Required) A comma separated list of permissions. Permissions can be specified as any:\n\n * permission returned by [Get all permissions](#api-rest-api-3-permissions-get).\n * custom project permission added by Connect apps.\n * (deprecated) one of the following:\n \n * ASSIGNABLE\\_USER\n * ASSIGN\\_ISSUE\n * ATTACHMENT\\_DELETE\\_ALL\n * ATTACHMENT\\_DELETE\\_OWN\n * BROWSE\n * CLOSE\\_ISSUE\n * COMMENT\\_DELETE\\_ALL\n * COMMENT\\_DELETE\\_OWN\n * COMMENT\\_EDIT\\_ALL\n * COMMENT\\_EDIT\\_OWN\n * COMMENT\\_ISSUE\n * CREATE\\_ATTACHMENT\n * CREATE\\_ISSUE\n * DELETE\\_ISSUE\n * EDIT\\_ISSUE\n * LINK\\_ISSUE\n * MANAGE\\_WATCHER\\_LIST\n * MODIFY\\_REPORTER\n * MOVE\\_ISSUE\n * PROJECT\\_ADMIN\n * RESOLVE\\_ISSUE\n * SCHEDULE\\_ISSUE\n * SET\\_ISSUE\\_SECURITY\n * TRANSITION\\_ISSUE\n * VIEW\\_VERSION\\_CONTROL\n * VIEW\\_VOTERS\\_AND\\_WATCHERS\n * VIEW\\_WORKFLOW\\_READONLY\n * WORKLOG\\_DELETE\\_ALL\n * WORKLOG\\_DELETE\\_OWN\n * WORKLOG\\_EDIT\\_ALL\n * WORKLOG\\_EDIT\\_OWN\n * WORK\\_ISSUE", "key": "permissions", "value": "" }, { "description": "The issue key for the issue.", "key": "issueKey", "value": "" }, { "description": "The project key for the project (case sensitive).", "key": "projectKey", "value": "" }, { "description": "The index of the first item to return in a page of results (page offset).", "key": "startAt", "value": "0" }, { "description": "The maximum number of items to return per page.", "key": "maxResults", "value": "50" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-d353285f-9b27-4ded-8909-ca9e326907d9" }, { "id": "77fbe11b-96d2-489c-8529-7e818500c263", "name": "Returned if the user does not have the necessary permission.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/rest/api/3/user/permission/search?query=&username=&accountId=&permissions=&issueKey=&projectKey=&startAt=0&maxResults=50", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "permission", "search" ], "query": [ { "description": "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 `accountId` is specified.", "key": "query", "value": "" }, { "description": "This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", "key": "username", "value": "" }, { "description": "A query string that is matched exactly against user `accountId`. Required, unless `query` is specified.", "key": "accountId", "value": "" }, { "description": "(Required) A comma separated list of permissions. Permissions can be specified as any:\n\n * permission returned by [Get all permissions](#api-rest-api-3-permissions-get).\n * custom project permission added by Connect apps.\n * (deprecated) one of the following:\n \n * ASSIGNABLE\\_USER\n * ASSIGN\\_ISSUE\n * ATTACHMENT\\_DELETE\\_ALL\n * ATTACHMENT\\_DELETE\\_OWN\n * BROWSE\n * CLOSE\\_ISSUE\n * COMMENT\\_DELETE\\_ALL\n * COMMENT\\_DELETE\\_OWN\n * COMMENT\\_EDIT\\_ALL\n * COMMENT\\_EDIT\\_OWN\n * COMMENT\\_ISSUE\n * CREATE\\_ATTACHMENT\n * CREATE\\_ISSUE\n * DELETE\\_ISSUE\n * EDIT\\_ISSUE\n * LINK\\_ISSUE\n * MANAGE\\_WATCHER\\_LIST\n * MODIFY\\_REPORTER\n * MOVE\\_ISSUE\n * PROJECT\\_ADMIN\n * RESOLVE\\_ISSUE\n * SCHEDULE\\_ISSUE\n * SET\\_ISSUE\\_SECURITY\n * TRANSITION\\_ISSUE\n * VIEW\\_VERSION\\_CONTROL\n * VIEW\\_VOTERS\\_AND\\_WATCHERS\n * VIEW\\_WORKFLOW\\_READONLY\n * WORKLOG\\_DELETE\\_ALL\n * WORKLOG\\_DELETE\\_OWN\n * WORKLOG\\_EDIT\\_ALL\n * WORKLOG\\_EDIT\\_OWN\n * WORK\\_ISSUE", "key": "permissions", "value": "" }, { "description": "The issue key for the issue.", "key": "issueKey", "value": "" }, { "description": "The project key for the project (case sensitive).", "key": "projectKey", "value": "" }, { "description": "The index of the first item to return in a page of results (page offset).", "key": "startAt", "value": "0" }, { "description": "The maximum number of items to return per page.", "key": "maxResults", "value": "50" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-77fbe11b-96d2-489c-8529-7e818500c263" }, { "id": "5435e5ff-d245-479c-955d-e528bf6f1710", "name": "Returned if the issue or project is not found.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/rest/api/3/user/permission/search?query=&username=&accountId=&permissions=&issueKey=&projectKey=&startAt=0&maxResults=50", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "permission", "search" ], "query": [ { "description": "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 `accountId` is specified.", "key": "query", "value": "" }, { "description": "This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", "key": "username", "value": "" }, { "description": "A query string that is matched exactly against user `accountId`. Required, unless `query` is specified.", "key": "accountId", "value": "" }, { "description": "(Required) A comma separated list of permissions. Permissions can be specified as any:\n\n * permission returned by [Get all permissions](#api-rest-api-3-permissions-get).\n * custom project permission added by Connect apps.\n * (deprecated) one of the following:\n \n * ASSIGNABLE\\_USER\n * ASSIGN\\_ISSUE\n * ATTACHMENT\\_DELETE\\_ALL\n * ATTACHMENT\\_DELETE\\_OWN\n * BROWSE\n * CLOSE\\_ISSUE\n * COMMENT\\_DELETE\\_ALL\n * COMMENT\\_DELETE\\_OWN\n * COMMENT\\_EDIT\\_ALL\n * COMMENT\\_EDIT\\_OWN\n * COMMENT\\_ISSUE\n * CREATE\\_ATTACHMENT\n * CREATE\\_ISSUE\n * DELETE\\_ISSUE\n * EDIT\\_ISSUE\n * LINK\\_ISSUE\n * MANAGE\\_WATCHER\\_LIST\n * MODIFY\\_REPORTER\n * MOVE\\_ISSUE\n * PROJECT\\_ADMIN\n * RESOLVE\\_ISSUE\n * SCHEDULE\\_ISSUE\n * SET\\_ISSUE\\_SECURITY\n * TRANSITION\\_ISSUE\n * VIEW\\_VERSION\\_CONTROL\n * VIEW\\_VOTERS\\_AND\\_WATCHERS\n * VIEW\\_WORKFLOW\\_READONLY\n * WORKLOG\\_DELETE\\_ALL\n * WORKLOG\\_DELETE\\_OWN\n * WORKLOG\\_EDIT\\_ALL\n * WORKLOG\\_EDIT\\_OWN\n * WORK\\_ISSUE", "key": "permissions", "value": "" }, { "description": "The issue key for the issue.", "key": "issueKey", "value": "" }, { "description": "The project key for the project (case sensitive).", "key": "projectKey", "value": "" }, { "description": "The index of the first item to return in a page of results (page offset).", "key": "startAt", "value": "0" }, { "description": "The maximum number of items to return per page.", "key": "maxResults", "value": "50" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-5435e5ff-d245-479c-955d-e528bf6f1710" }, { "id": "42b124a0-41f8-4931-a400-c59ffa51afcf", "name": "Returned 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.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/rest/api/3/user/permission/search?query=&username=&accountId=&permissions=&issueKey=&projectKey=&startAt=0&maxResults=50", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "permission", "search" ], "query": [ { "description": "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 `accountId` is specified.", "key": "query", "value": "" }, { "description": "This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", "key": "username", "value": "" }, { "description": "A query string that is matched exactly against user `accountId`. Required, unless `query` is specified.", "key": "accountId", "value": "" }, { "description": "(Required) A comma separated list of permissions. Permissions can be specified as any:\n\n * permission returned by [Get all permissions](#api-rest-api-3-permissions-get).\n * custom project permission added by Connect apps.\n * (deprecated) one of the following:\n \n * ASSIGNABLE\\_USER\n * ASSIGN\\_ISSUE\n * ATTACHMENT\\_DELETE\\_ALL\n * ATTACHMENT\\_DELETE\\_OWN\n * BROWSE\n * CLOSE\\_ISSUE\n * COMMENT\\_DELETE\\_ALL\n * COMMENT\\_DELETE\\_OWN\n * COMMENT\\_EDIT\\_ALL\n * COMMENT\\_EDIT\\_OWN\n * COMMENT\\_ISSUE\n * CREATE\\_ATTACHMENT\n * CREATE\\_ISSUE\n * DELETE\\_ISSUE\n * EDIT\\_ISSUE\n * LINK\\_ISSUE\n * MANAGE\\_WATCHER\\_LIST\n * MODIFY\\_REPORTER\n * MOVE\\_ISSUE\n * PROJECT\\_ADMIN\n * RESOLVE\\_ISSUE\n * SCHEDULE\\_ISSUE\n * SET\\_ISSUE\\_SECURITY\n * TRANSITION\\_ISSUE\n * VIEW\\_VERSION\\_CONTROL\n * VIEW\\_VOTERS\\_AND\\_WATCHERS\n * VIEW\\_WORKFLOW\\_READONLY\n * WORKLOG\\_DELETE\\_ALL\n * WORKLOG\\_DELETE\\_OWN\n * WORKLOG\\_EDIT\\_ALL\n * WORKLOG\\_EDIT\\_OWN\n * WORK\\_ISSUE", "key": "permissions", "value": "" }, { "description": "The issue key for the issue.", "key": "issueKey", "value": "" }, { "description": "The project key for the project (case sensitive).", "key": "projectKey", "value": "" }, { "description": "The index of the first item to return in a page of results (page offset).", "key": "startAt", "value": "0" }, { "description": "The maximum number of items to return per page.", "key": "maxResults", "value": "50" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-42b124a0-41f8-4931-a400-c59ffa51afcf" } ], "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-4a82fb9f-6b64-425a-ae4b-8cbd6253edf7" } ], "id": "94c01a4f-4174-4c12-a4b8-8a0b4b797948", "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-94c01a4f-4174-4c12-a4b8-8a0b4b797948" } ], "id": "229737c1-64e7-4991-822d-3d604342420d", "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-229737c1-64e7-4991-822d-3d604342420d" }, { "name": "picker", "item": [ { "name": "Atlassian Find Users For Picker", "id": "cf05e93b-cb96-48c8-b369-69cca6aa05f5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rest/api/3/user/picker?query=&maxResults=50&showAvatar=false&exclude=&exclude=&excludeAccountIds=&excludeAccountIds=&avatarSize=&excludeConnectUsers=false", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "picker" ], "query": [ { "description": "(Required) 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*.", "key": "query", "value": "" }, { "description": "The maximum number of items to return. The total number of matched users is returned in `total`.", "key": "maxResults", "value": "50" }, { "description": "Include the URI to the user's avatar.", "key": "showAvatar", "value": "false" }, { "description": "This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", "key": "exclude", "value": "" }, { "description": "This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", "key": "exclude", "value": "" }, { "description": "A list of account IDs to exclude from the search results. This parameter accepts a comma-separated list. Multiple account IDs can also be provided using an ampersand-separated list. For example, `excludeAccountIds=5b10a2844c20165700ede21g,5b10a0effa615349cb016cd8&excludeAccountIds=5b10ac8d82e05b22cc7d4ef5`. Cannot be provided with `exclude`.", "key": "excludeAccountIds", "value": "" }, { "description": "A list of account IDs to exclude from the search results. This parameter accepts a comma-separated list. Multiple account IDs can also be provided using an ampersand-separated list. For example, `excludeAccountIds=5b10a2844c20165700ede21g,5b10a0effa615349cb016cd8&excludeAccountIds=5b10ac8d82e05b22cc7d4ef5`. Cannot be provided with `exclude`.", "key": "excludeAccountIds", "value": "" }, { "key": "avatarSize", "value": "" }, { "key": "excludeConnectUsers", "value": "false" } ] }, "description": "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](#api-rest-api-3-users-search-get) 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](https://developer.atlassian.com/cloud/jira/platform/profile-visibility/) for more details.

This operation can be accessed anonymously.

**[Permissions](#permissions) required:** *Browse users and groups* [global permission](https://confluence.atlassian.com/x/x4dKLg). Anonymous calls and calls by users without the required permission return search results for an exact name match only." }, "response": [ { "id": "d928b754-da9b-4090-9485-d40022944ca7", "name": "Returned if the request is successful.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rest/api/3/user/picker?query=&maxResults=50&showAvatar=false&exclude=&excludeAccountIds=&avatarSize=&excludeConnectUsers=false", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "picker" ], "query": [ { "description": "(Required) 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*.", "key": "query", "value": "" }, { "description": "The maximum number of items to return. The total number of matched users is returned in `total`.", "key": "maxResults", "value": "50" }, { "description": "Include the URI to the user's avatar.", "key": "showAvatar", "value": "false" }, { "description": "This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", "key": "exclude", "value": "" }, { "description": "A list of account IDs to exclude from the search results. This parameter accepts a comma-separated list. Multiple account IDs can also be provided using an ampersand-separated list. For example, `excludeAccountIds=5b10a2844c20165700ede21g,5b10a0effa615349cb016cd8&excludeAccountIds=5b10ac8d82e05b22cc7d4ef5`. Cannot be provided with `exclude`.", "key": "excludeAccountIds", "value": "" }, { "key": "avatarSize", "value": "" }, { "key": "excludeConnectUsers", "value": "false" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"header\": \"\",\n \"total\": \"\",\n \"users\": [\n {\n \"value\": \"reference #/components/schemas/UserPickerUser not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/UserPickerUser not found in the OpenAPI spec\"\n }\n ]\n}", "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-d928b754-da9b-4090-9485-d40022944ca7" }, { "id": "a9acd395-2ed5-49c9-81a8-a8c6cf91451f", "name": "Returned if `exclude` and `excludeAccountIds` are provided.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/rest/api/3/user/picker?query=&maxResults=50&showAvatar=false&exclude=&excludeAccountIds=&avatarSize=&excludeConnectUsers=false", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "picker" ], "query": [ { "description": "(Required) 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*.", "key": "query", "value": "" }, { "description": "The maximum number of items to return. The total number of matched users is returned in `total`.", "key": "maxResults", "value": "50" }, { "description": "Include the URI to the user's avatar.", "key": "showAvatar", "value": "false" }, { "description": "This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", "key": "exclude", "value": "" }, { "description": "A list of account IDs to exclude from the search results. This parameter accepts a comma-separated list. Multiple account IDs can also be provided using an ampersand-separated list. For example, `excludeAccountIds=5b10a2844c20165700ede21g,5b10a0effa615349cb016cd8&excludeAccountIds=5b10ac8d82e05b22cc7d4ef5`. Cannot be provided with `exclude`.", "key": "excludeAccountIds", "value": "" }, { "key": "avatarSize", "value": "" }, { "key": "excludeConnectUsers", "value": "false" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-a9acd395-2ed5-49c9-81a8-a8c6cf91451f" }, { "id": "54664779-c275-47c7-90df-c9ea0cfd210f", "name": "Returned if the authentication credentials are incorrect or missing.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/rest/api/3/user/picker?query=&maxResults=50&showAvatar=false&exclude=&excludeAccountIds=&avatarSize=&excludeConnectUsers=false", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "picker" ], "query": [ { "description": "(Required) 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*.", "key": "query", "value": "" }, { "description": "The maximum number of items to return. The total number of matched users is returned in `total`.", "key": "maxResults", "value": "50" }, { "description": "Include the URI to the user's avatar.", "key": "showAvatar", "value": "false" }, { "description": "This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", "key": "exclude", "value": "" }, { "description": "A list of account IDs to exclude from the search results. This parameter accepts a comma-separated list. Multiple account IDs can also be provided using an ampersand-separated list. For example, `excludeAccountIds=5b10a2844c20165700ede21g,5b10a0effa615349cb016cd8&excludeAccountIds=5b10ac8d82e05b22cc7d4ef5`. Cannot be provided with `exclude`.", "key": "excludeAccountIds", "value": "" }, { "key": "avatarSize", "value": "" }, { "key": "excludeConnectUsers", "value": "false" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-54664779-c275-47c7-90df-c9ea0cfd210f" }, { "id": "127acd59-0d5b-4c17-bad9-c2c0536993f2", "name": "Returned 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.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/rest/api/3/user/picker?query=&maxResults=50&showAvatar=false&exclude=&excludeAccountIds=&avatarSize=&excludeConnectUsers=false", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "picker" ], "query": [ { "description": "(Required) 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*.", "key": "query", "value": "" }, { "description": "The maximum number of items to return. The total number of matched users is returned in `total`.", "key": "maxResults", "value": "50" }, { "description": "Include the URI to the user's avatar.", "key": "showAvatar", "value": "false" }, { "description": "This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", "key": "exclude", "value": "" }, { "description": "A list of account IDs to exclude from the search results. This parameter accepts a comma-separated list. Multiple account IDs can also be provided using an ampersand-separated list. For example, `excludeAccountIds=5b10a2844c20165700ede21g,5b10a0effa615349cb016cd8&excludeAccountIds=5b10ac8d82e05b22cc7d4ef5`. Cannot be provided with `exclude`.", "key": "excludeAccountIds", "value": "" }, { "key": "avatarSize", "value": "" }, { "key": "excludeConnectUsers", "value": "false" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-127acd59-0d5b-4c17-bad9-c2c0536993f2" } ], "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-cf05e93b-cb96-48c8-b369-69cca6aa05f5" } ], "id": "02b3a656-12d4-4d11-a76b-f8de0008bda2", "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-02b3a656-12d4-4d11-a76b-f8de0008bda2" }, { "name": "properties", "item": [ { "name": "{propertyKey}", "item": [ { "name": "Atlassian Delete User Property", "id": "205b1608-e776-4ae6-ae3e-131718fbbc23", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/rest/api/3/user/properties/:propertyKey?accountId=&userKey=&username=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "properties", ":propertyKey" ], "query": [ { "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.", "key": "accountId", "value": "" }, { "description": "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.", "key": "userKey", "value": "" }, { "description": "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.", "key": "username", "value": "" } ], "variable": [ { "id": "93a8d9eb-ff37-4044-bb99-ad191db269db", "key": "propertyKey", "value": "", "description": "(Required) The key of the user's property." } ] }, "description": "Deletes a property from a user.

Note: This operation does not access the [user properties](https://confluence.atlassian.com/x/8YxjL) created and maintained in Jira.

**[Permissions](#permissions) required:**

* *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg), to delete a property from any user.
* Access to Jira, to delete a property from the calling user's record." }, "response": [ { "id": "7b257842-e511-422e-a1c3-91a5b77886da", "name": "Returned if the user property is deleted.", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/rest/api/3/user/properties/:propertyKey?accountId=&userKey=&username=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "properties", ":propertyKey" ], "query": [ { "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.", "key": "accountId", "value": "" }, { "description": "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.", "key": "userKey", "value": "" }, { "description": "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.", "key": "username", "value": "" } ], "variable": [ { "key": "propertyKey" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-7b257842-e511-422e-a1c3-91a5b77886da" }, { "id": "1e9fc601-c9ae-4ffe-b67c-c018fc1fc9bb", "name": "Returned if `accountId` is missing.", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/rest/api/3/user/properties/:propertyKey?accountId=&userKey=&username=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "properties", ":propertyKey" ], "query": [ { "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.", "key": "accountId", "value": "" }, { "description": "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.", "key": "userKey", "value": "" }, { "description": "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.", "key": "username", "value": "" } ], "variable": [ { "key": "propertyKey" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-1e9fc601-c9ae-4ffe-b67c-c018fc1fc9bb" }, { "id": "b6f9f5ca-bb4b-4857-88d4-d0fedcbe889b", "name": "Returned if the authentication credentials are incorrect or missing.", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/rest/api/3/user/properties/:propertyKey?accountId=&userKey=&username=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "properties", ":propertyKey" ], "query": [ { "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.", "key": "accountId", "value": "" }, { "description": "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.", "key": "userKey", "value": "" }, { "description": "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.", "key": "username", "value": "" } ], "variable": [ { "key": "propertyKey" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-b6f9f5ca-bb4b-4857-88d4-d0fedcbe889b" }, { "id": "3dbeaa06-83eb-4354-8ec1-3a87696e63e8", "name": "Returned if the user does not have the necessary permission or is not accessing their user record.", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/rest/api/3/user/properties/:propertyKey?accountId=&userKey=&username=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "properties", ":propertyKey" ], "query": [ { "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.", "key": "accountId", "value": "" }, { "description": "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.", "key": "userKey", "value": "" }, { "description": "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.", "key": "username", "value": "" } ], "variable": [ { "key": "propertyKey" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-3dbeaa06-83eb-4354-8ec1-3a87696e63e8" }, { "id": "bffdbbeb-63e3-4c47-acd2-a29c940b21da", "name": "Returned if the user or the property is not found.", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/rest/api/3/user/properties/:propertyKey?accountId=&userKey=&username=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "properties", ":propertyKey" ], "query": [ { "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.", "key": "accountId", "value": "" }, { "description": "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.", "key": "userKey", "value": "" }, { "description": "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.", "key": "username", "value": "" } ], "variable": [ { "key": "propertyKey" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-bffdbbeb-63e3-4c47-acd2-a29c940b21da" } ], "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-205b1608-e776-4ae6-ae3e-131718fbbc23" }, { "name": "Atlassian Get User Property", "id": "1e9ac0de-a895-4eac-962f-c80fbb8d198a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rest/api/3/user/properties/:propertyKey?accountId=&userKey=&username=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "properties", ":propertyKey" ], "query": [ { "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.", "key": "accountId", "value": "" }, { "description": "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.", "key": "userKey", "value": "" }, { "description": "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.", "key": "username", "value": "" } ], "variable": [ { "id": "be06e643-7d46-4497-b4e4-056f43ad800a", "key": "propertyKey", "value": "", "description": "(Required) The key of the user's property." } ] }, "description": "Returns the value of a user's property. If no property key is provided [Get user property keys](#api-rest-api-3-user-properties-get) is called.

Note: This operation does not access the [user properties](https://confluence.atlassian.com/x/8YxjL) created and maintained in Jira.

**[Permissions](#permissions) required:**

* *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg), to get a property from any user.
* Access to Jira, to get a property from the calling user's record." }, "response": [ { "id": "fec7f84b-e479-41fe-9421-5943dfcbcf7f", "name": "Returned if the request is successful.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rest/api/3/user/properties/:propertyKey?accountId=&userKey=&username=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "properties", ":propertyKey" ], "query": [ { "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.", "key": "accountId", "value": "" }, { "description": "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.", "key": "userKey", "value": "" }, { "description": "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.", "key": "username", "value": "" } ], "variable": [ { "key": "propertyKey" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"key\": \"\",\n \"value\": {\n \"description\": \"The value of the property. Required on create and update.\"\n }\n}", "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-fec7f84b-e479-41fe-9421-5943dfcbcf7f" }, { "id": "f690417b-538b-4701-b6d4-58cc7431482a", "name": "Returned if `accountId` is missing.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/rest/api/3/user/properties/:propertyKey?accountId=&userKey=&username=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "properties", ":propertyKey" ], "query": [ { "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.", "key": "accountId", "value": "" }, { "description": "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.", "key": "userKey", "value": "" }, { "description": "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.", "key": "username", "value": "" } ], "variable": [ { "key": "propertyKey" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-f690417b-538b-4701-b6d4-58cc7431482a" }, { "id": "be24a279-7a59-4820-bcb6-afea599913ca", "name": "Returned if the authentication credentials are incorrect or missing.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/rest/api/3/user/properties/:propertyKey?accountId=&userKey=&username=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "properties", ":propertyKey" ], "query": [ { "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.", "key": "accountId", "value": "" }, { "description": "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.", "key": "userKey", "value": "" }, { "description": "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.", "key": "username", "value": "" } ], "variable": [ { "key": "propertyKey" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-be24a279-7a59-4820-bcb6-afea599913ca" }, { "id": "13d2dd4c-4680-4500-8a6f-adb78b296aff", "name": "Returned if the user does not have the necessary permission or is not accessing their user record.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/rest/api/3/user/properties/:propertyKey?accountId=&userKey=&username=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "properties", ":propertyKey" ], "query": [ { "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.", "key": "accountId", "value": "" }, { "description": "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.", "key": "userKey", "value": "" }, { "description": "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.", "key": "username", "value": "" } ], "variable": [ { "key": "propertyKey" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-13d2dd4c-4680-4500-8a6f-adb78b296aff" }, { "id": "5a19aabe-77ae-4dc4-b2be-87d9e8e89953", "name": "Returned if the user is not found.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/rest/api/3/user/properties/:propertyKey?accountId=&userKey=&username=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "properties", ":propertyKey" ], "query": [ { "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.", "key": "accountId", "value": "" }, { "description": "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.", "key": "userKey", "value": "" }, { "description": "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.", "key": "username", "value": "" } ], "variable": [ { "key": "propertyKey" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-5a19aabe-77ae-4dc4-b2be-87d9e8e89953" } ], "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-1e9ac0de-a895-4eac-962f-c80fbb8d198a" }, { "name": "Atlassian Set User Property", "id": "fece614b-0746-47fd-8cd3-1afde96629f2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/api/3/user/properties/:propertyKey?accountId=&userKey=&username=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "properties", ":propertyKey" ], "query": [ { "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.", "key": "accountId", "value": "" }, { "description": "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.", "key": "userKey", "value": "" }, { "description": "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.", "key": "username", "value": "" } ], "variable": [ { "id": "73e08304-552f-4ec6-a515-2f012db8b243", "key": "propertyKey", "value": "", "description": "(Required) The key of the user's property. The maximum length is 255 characters." } ] }, "description": "Sets the value of a user's property. Use this resource to store custom data against a user.

Note: This operation does not access the [user properties](https://confluence.atlassian.com/x/8YxjL) created and maintained in Jira.

**[Permissions](#permissions) required:**

* *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg), to set a property on any user.
* Access to Jira, to set a property on the calling user's record." }, "response": [ { "id": "6679d255-dbae-4d76-be78-17306803b729", "name": "Returned if the user property is updated.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/api/3/user/properties/:propertyKey?accountId=&userKey=&username=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "properties", ":propertyKey" ], "query": [ { "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.", "key": "accountId", "value": "" }, { "description": "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.", "key": "userKey", "value": "" }, { "description": "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.", "key": "username", "value": "" } ], "variable": [ { "key": "propertyKey" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-6679d255-dbae-4d76-be78-17306803b729" }, { "id": "eec7c922-455e-40fd-bf22-0360c4f86241", "name": "Returned if the user property is created.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/api/3/user/properties/:propertyKey?accountId=&userKey=&username=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "properties", ":propertyKey" ], "query": [ { "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.", "key": "accountId", "value": "" }, { "description": "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.", "key": "userKey", "value": "" }, { "description": "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.", "key": "username", "value": "" } ], "variable": [ { "key": "propertyKey" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-eec7c922-455e-40fd-bf22-0360c4f86241" }, { "id": "02653385-38ff-490c-b002-d4572c550d4c", "name": "Returned if `accountId` is missing.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/api/3/user/properties/:propertyKey?accountId=&userKey=&username=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "properties", ":propertyKey" ], "query": [ { "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.", "key": "accountId", "value": "" }, { "description": "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.", "key": "userKey", "value": "" }, { "description": "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.", "key": "username", "value": "" } ], "variable": [ { "key": "propertyKey" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-02653385-38ff-490c-b002-d4572c550d4c" }, { "id": "7db1e749-a3e4-467d-ab96-45aa4dc8e2c0", "name": "Returned if the authentication credentials are incorrect or missing.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/api/3/user/properties/:propertyKey?accountId=&userKey=&username=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "properties", ":propertyKey" ], "query": [ { "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.", "key": "accountId", "value": "" }, { "description": "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.", "key": "userKey", "value": "" }, { "description": "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.", "key": "username", "value": "" } ], "variable": [ { "key": "propertyKey" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-7db1e749-a3e4-467d-ab96-45aa4dc8e2c0" }, { "id": "736eb769-62af-49b7-bd06-596cd20c24fc", "name": "Returned if the user does not have the necessary permission or is not accessing their user record.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/api/3/user/properties/:propertyKey?accountId=&userKey=&username=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "properties", ":propertyKey" ], "query": [ { "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.", "key": "accountId", "value": "" }, { "description": "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.", "key": "userKey", "value": "" }, { "description": "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.", "key": "username", "value": "" } ], "variable": [ { "key": "propertyKey" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-736eb769-62af-49b7-bd06-596cd20c24fc" }, { "id": "2b5b16db-70a3-45d6-a309-80b5e5a87d9f", "name": "Returned if the user is not found.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/api/3/user/properties/:propertyKey?accountId=&userKey=&username=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "properties", ":propertyKey" ], "query": [ { "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.", "key": "accountId", "value": "" }, { "description": "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.", "key": "userKey", "value": "" }, { "description": "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.", "key": "username", "value": "" } ], "variable": [ { "key": "propertyKey" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-2b5b16db-70a3-45d6-a309-80b5e5a87d9f" }, { "id": "bc31c647-3bbd-45c3-bb00-14bf73b438bb", "name": "Returned if the property key is not specified.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/api/3/user/properties/:propertyKey?accountId=&userKey=&username=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "properties", ":propertyKey" ], "query": [ { "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.", "key": "accountId", "value": "" }, { "description": "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.", "key": "userKey", "value": "" }, { "description": "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.", "key": "username", "value": "" } ], "variable": [ { "key": "propertyKey" } ] } }, "status": "Method Not Allowed", "code": 405, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-bc31c647-3bbd-45c3-bb00-14bf73b438bb" } ], "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-fece614b-0746-47fd-8cd3-1afde96629f2" } ], "id": "64400b36-9503-436b-bfa6-99be2509e7d0", "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-64400b36-9503-436b-bfa6-99be2509e7d0" }, { "name": "Atlassian Get User Property Keys", "id": "aa4f1b11-74fe-4fd3-ba4b-8191f9c8fdcf", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rest/api/3/user/properties?accountId=&userKey=&username=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "properties" ], "query": [ { "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.", "key": "accountId", "value": "" }, { "description": "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.", "key": "userKey", "value": "" }, { "description": "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.", "key": "username", "value": "" } ] }, "description": "Returns the keys of all properties for a user.

Note: This operation does not access the [user properties](https://confluence.atlassian.com/x/8YxjL) created and maintained in Jira.

**[Permissions](#permissions) required:**

* *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg), to access the property keys on any user.
* Access to Jira, to access the calling user's property keys." }, "response": [ { "id": "f500412a-6f42-437c-9cf8-1b74f7c3c135", "name": "Returned if the request is successful.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rest/api/3/user/properties?accountId=&userKey=&username=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "properties" ], "query": [ { "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.", "key": "accountId", "value": "" }, { "description": "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.", "key": "userKey", "value": "" }, { "description": "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.", "key": "username", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"keys\": [\n {\n \"value\": \"reference #/components/schemas/PropertyKey not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/PropertyKey not found in the OpenAPI spec\"\n }\n ]\n}", "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-f500412a-6f42-437c-9cf8-1b74f7c3c135" }, { "id": "af779902-6153-4331-bb8b-1c58854943dd", "name": "Returned if `accountId` is missing.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/rest/api/3/user/properties?accountId=&userKey=&username=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "properties" ], "query": [ { "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.", "key": "accountId", "value": "" }, { "description": "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.", "key": "userKey", "value": "" }, { "description": "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.", "key": "username", "value": "" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-af779902-6153-4331-bb8b-1c58854943dd" }, { "id": "900280b6-4810-4083-bc90-4be312d4ca90", "name": "Returned if the authentication credentials are incorrect or missing.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/rest/api/3/user/properties?accountId=&userKey=&username=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "properties" ], "query": [ { "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.", "key": "accountId", "value": "" }, { "description": "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.", "key": "userKey", "value": "" }, { "description": "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.", "key": "username", "value": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-900280b6-4810-4083-bc90-4be312d4ca90" }, { "id": "0d71af3a-2fed-46e5-a77a-b11a463ea86b", "name": "Returned if the user does not have the necessary permission or is not accessing their user record.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/rest/api/3/user/properties?accountId=&userKey=&username=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "properties" ], "query": [ { "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.", "key": "accountId", "value": "" }, { "description": "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.", "key": "userKey", "value": "" }, { "description": "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.", "key": "username", "value": "" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-0d71af3a-2fed-46e5-a77a-b11a463ea86b" }, { "id": "1b10a184-b67b-4ab3-a8ac-07f76a5c5c21", "name": "Returned if the user is not found.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/rest/api/3/user/properties?accountId=&userKey=&username=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "properties" ], "query": [ { "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.", "key": "accountId", "value": "" }, { "description": "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.", "key": "userKey", "value": "" }, { "description": "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.", "key": "username", "value": "" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-1b10a184-b67b-4ab3-a8ac-07f76a5c5c21" } ], "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-aa4f1b11-74fe-4fd3-ba4b-8191f9c8fdcf" } ], "id": "1dc1a33c-67ef-4c6b-ad76-d8d20f028980", "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-1dc1a33c-67ef-4c6b-ad76-d8d20f028980" }, { "name": "search", "item": [ { "name": "query", "item": [ { "name": "key", "item": [ { "name": "Atlassian Find User Keys By Query", "id": "3f9672b8-6b8c-4347-9e3d-a549c5bde5b1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rest/api/3/user/search/query/key?query=&startAt=0&maxResult=100", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "search", "query", "key" ], "query": [ { "description": "(Required) The search query.", "key": "query", "value": "" }, { "description": "The index of the first item to return in a page of results (page offset).", "key": "startAt", "value": "0" }, { "description": "The maximum number of items to return per page.", "key": "maxResult", "value": "100" } ] }, "description": "Finds users with a structured query and returns a [paginated](#pagination) list of user keys.

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](#api-rest-api-3-users-search-get) and filter the records in your code.

**[Permissions](#permissions) required:** *Browse users and groups* [global permission](https://confluence.atlassian.com/x/x4dKLg).

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\"`" }, "response": [ { "id": "94d5f811-e474-4519-bbf6-8b4620e45ae1", "name": "Returned if the request is successful.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rest/api/3/user/search/query/key?query=&startAt=0&maxResult=100", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "search", "query", "key" ], "query": [ { "description": "(Required) The search query.", "key": "query", "value": "" }, { "description": "The index of the first item to return in a page of results (page offset).", "key": "startAt", "value": "0" }, { "description": "The maximum number of items to return per page.", "key": "maxResult", "value": "100" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"isLast\": \"\",\n \"maxResults\": \"\",\n \"nextPage\": \"\",\n \"self\": \"\",\n \"startAt\": \"\",\n \"total\": \"\",\n \"values\": [\n {\n \"value\": \"reference #/components/schemas/UserKey not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/UserKey not found in the OpenAPI spec\"\n }\n ]\n}", "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-94d5f811-e474-4519-bbf6-8b4620e45ae1" }, { "id": "7f810ccf-3709-405e-bffb-8905de9ee4e5", "name": "Returned if the query is invalid.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rest/api/3/user/search/query/key?query=&startAt=0&maxResult=100", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "search", "query", "key" ], "query": [ { "description": "(Required) The search query.", "key": "query", "value": "" }, { "description": "The index of the first item to return in a page of results (page offset).", "key": "startAt", "value": "0" }, { "description": "The maximum number of items to return per page.", "key": "maxResult", "value": "100" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"value\": \"reference #/components/schemas/ErrorCollection not found in the OpenAPI spec\"\n}", "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-7f810ccf-3709-405e-bffb-8905de9ee4e5" }, { "id": "ba8c9515-abca-417c-9e26-9354c4381b52", "name": "Returned if the authentication credentials are incorrect or missing.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rest/api/3/user/search/query/key?query=&startAt=0&maxResult=100", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "search", "query", "key" ], "query": [ { "description": "(Required) The search query.", "key": "query", "value": "" }, { "description": "The index of the first item to return in a page of results (page offset).", "key": "startAt", "value": "0" }, { "description": "The maximum number of items to return per page.", "key": "maxResult", "value": "100" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"value\": \"reference #/components/schemas/ErrorCollection not found in the OpenAPI spec\"\n}", "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-ba8c9515-abca-417c-9e26-9354c4381b52" }, { "id": "e42433a6-491a-45ea-af44-bcb7aeec506b", "name": "Returned if the user does not have the necessary permission.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rest/api/3/user/search/query/key?query=&startAt=0&maxResult=100", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "search", "query", "key" ], "query": [ { "description": "(Required) The search query.", "key": "query", "value": "" }, { "description": "The index of the first item to return in a page of results (page offset).", "key": "startAt", "value": "0" }, { "description": "The maximum number of items to return per page.", "key": "maxResult", "value": "100" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"value\": \"reference #/components/schemas/ErrorCollection not found in the OpenAPI spec\"\n}", "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-e42433a6-491a-45ea-af44-bcb7aeec506b" }, { "id": "ec21753d-43c5-421f-9e52-0f06a43922e0", "name": "Returned if the search is timed out.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rest/api/3/user/search/query/key?query=&startAt=0&maxResult=100", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "search", "query", "key" ], "query": [ { "description": "(Required) The search query.", "key": "query", "value": "" }, { "description": "The index of the first item to return in a page of results (page offset).", "key": "startAt", "value": "0" }, { "description": "The maximum number of items to return per page.", "key": "maxResult", "value": "100" } ] } }, "status": "Request Timeout", "code": 408, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"value\": \"reference #/components/schemas/ErrorCollection not found in the OpenAPI spec\"\n}", "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-ec21753d-43c5-421f-9e52-0f06a43922e0" } ], "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-3f9672b8-6b8c-4347-9e3d-a549c5bde5b1" } ], "id": "30620af3-9579-4bc7-b8f8-9d67bf9abe6e", "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-30620af3-9579-4bc7-b8f8-9d67bf9abe6e" }, { "name": "Atlassian Find Users By Query", "id": "2ded3dbf-58c6-49d1-a6fb-a6ff1fa479b5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rest/api/3/user/search/query?query=&startAt=0&maxResults=100", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "search", "query" ], "query": [ { "description": "(Required) The search query.", "key": "query", "value": "" }, { "description": "The index of the first item to return in a page of results (page offset).", "key": "startAt", "value": "0" }, { "description": "The maximum number of items to return per page.", "key": "maxResults", "value": "100" } ] }, "description": "Finds users with a structured query and returns a [paginated](#pagination) 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](#api-rest-api-3-users-search-get) and filter the records in your code.

**[Permissions](#permissions) required:** *Browse users and groups* [global permission](https://confluence.atlassian.com/x/x4dKLg).

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\"`" }, "response": [ { "id": "1b2ec5d1-f5d2-4776-9ce7-ab36e8cdaad7", "name": "Returned if the request is successful.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rest/api/3/user/search/query?query=&startAt=0&maxResults=100", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "search", "query" ], "query": [ { "description": "(Required) The search query.", "key": "query", "value": "" }, { "description": "The index of the first item to return in a page of results (page offset).", "key": "startAt", "value": "0" }, { "description": "The maximum number of items to return per page.", "key": "maxResults", "value": "100" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"isLast\": \"\",\n \"maxResults\": \"\",\n \"nextPage\": \"\",\n \"self\": \"\",\n \"startAt\": \"\",\n \"total\": \"\",\n \"values\": [\n {\n \"value\": \"reference #/components/schemas/User not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/User not found in the OpenAPI spec\"\n }\n ]\n}", "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-1b2ec5d1-f5d2-4776-9ce7-ab36e8cdaad7" }, { "id": "0c15363a-fb67-4eeb-a82c-bfcc2e58bf91", "name": "Returned if the query is invalid.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rest/api/3/user/search/query?query=&startAt=0&maxResults=100", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "search", "query" ], "query": [ { "description": "(Required) The search query.", "key": "query", "value": "" }, { "description": "The index of the first item to return in a page of results (page offset).", "key": "startAt", "value": "0" }, { "description": "The maximum number of items to return per page.", "key": "maxResults", "value": "100" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"value\": \"reference #/components/schemas/ErrorCollection not found in the OpenAPI spec\"\n}", "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-0c15363a-fb67-4eeb-a82c-bfcc2e58bf91" }, { "id": "f68c6e55-e450-445b-9ff4-ab1fc2e2f039", "name": "Returned if the authentication credentials are incorrect or missing.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rest/api/3/user/search/query?query=&startAt=0&maxResults=100", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "search", "query" ], "query": [ { "description": "(Required) The search query.", "key": "query", "value": "" }, { "description": "The index of the first item to return in a page of results (page offset).", "key": "startAt", "value": "0" }, { "description": "The maximum number of items to return per page.", "key": "maxResults", "value": "100" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"value\": \"reference #/components/schemas/ErrorCollection not found in the OpenAPI spec\"\n}", "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-f68c6e55-e450-445b-9ff4-ab1fc2e2f039" }, { "id": "a6ce7ad0-9553-4c78-be83-9dd638a4f016", "name": "Returned if the user does not have the necessary permission.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rest/api/3/user/search/query?query=&startAt=0&maxResults=100", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "search", "query" ], "query": [ { "description": "(Required) The search query.", "key": "query", "value": "" }, { "description": "The index of the first item to return in a page of results (page offset).", "key": "startAt", "value": "0" }, { "description": "The maximum number of items to return per page.", "key": "maxResults", "value": "100" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"value\": \"reference #/components/schemas/ErrorCollection not found in the OpenAPI spec\"\n}", "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-a6ce7ad0-9553-4c78-be83-9dd638a4f016" }, { "id": "5ea0a05d-4027-48e6-9c24-c73e55affb46", "name": "Returned if the search is timed out.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rest/api/3/user/search/query?query=&startAt=0&maxResults=100", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "search", "query" ], "query": [ { "description": "(Required) The search query.", "key": "query", "value": "" }, { "description": "The index of the first item to return in a page of results (page offset).", "key": "startAt", "value": "0" }, { "description": "The maximum number of items to return per page.", "key": "maxResults", "value": "100" } ] } }, "status": "Request Timeout", "code": 408, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"value\": \"reference #/components/schemas/ErrorCollection not found in the OpenAPI spec\"\n}", "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-5ea0a05d-4027-48e6-9c24-c73e55affb46" } ], "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-2ded3dbf-58c6-49d1-a6fb-a6ff1fa479b5" } ], "id": "2b570ade-5769-48db-8d08-a100b775758e", "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-2b570ade-5769-48db-8d08-a100b775758e" }, { "name": "Atlassian Find Users", "id": "00010aea-f97b-41a2-8c7d-a28c144da4c8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rest/api/3/user/search?query=&username=&accountId=&startAt=0&maxResults=50&property=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "search" ], "query": [ { "description": "A query string that is matched against user attributes ( `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 `accountId` or `property` is specified.", "key": "query", "value": "" }, { "key": "username", "value": "" }, { "description": "A query string that is matched exactly against a user `accountId`. Required, unless `query` or `property` is specified.", "key": "accountId", "value": "" }, { "description": "The index of the first item to return in a page of filtered results (page offset).", "key": "startAt", "value": "0" }, { "description": "The maximum number of items to return per page.", "key": "maxResults", "value": "50" }, { "description": "A query string used to search properties. Property keys are specified by path, so property keys containing dot (.) or equals (=) characters cannot be used. The query string cannot be specified using a JSON object. Example: To search for the value of `nested` from `{\"something\":{\"nested\":1,\"other\":2}}` use `thepropertykey.something.nested=1`. Required, unless `accountId` or `query` is specified.", "key": "property", "value": "" } ] }, "description": "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](#api-rest-api-3-users-search-get) and filter the records in your code.

This operation can be accessed anonymously.

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](https://developer.atlassian.com/cloud/jira/platform/profile-visibility/) for more details.

**[Permissions](#permissions) required:** *Browse users and groups* [global permission](https://confluence.atlassian.com/x/x4dKLg). Anonymous calls or calls by users without the required permission return empty search results." }, "response": [ { "id": "4d7110b9-b7b0-4abe-9130-1900a070b6ce", "name": "Returned if the request is successful.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rest/api/3/user/search?query=&username=&accountId=&startAt=0&maxResults=50&property=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "search" ], "query": [ { "description": "A query string that is matched against user attributes ( `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 `accountId` or `property` is specified.", "key": "query", "value": "" }, { "key": "username", "value": "" }, { "description": "A query string that is matched exactly against a user `accountId`. Required, unless `query` or `property` is specified.", "key": "accountId", "value": "" }, { "description": "The index of the first item to return in a page of filtered results (page offset).", "key": "startAt", "value": "0" }, { "description": "The maximum number of items to return per page.", "key": "maxResults", "value": "50" }, { "description": "A query string used to search properties. Property keys are specified by path, so property keys containing dot (.) or equals (=) characters cannot be used. The query string cannot be specified using a JSON object. Example: To search for the value of `nested` from `{\"something\":{\"nested\":1,\"other\":2}}` use `thepropertykey.something.nested=1`. Required, unless `accountId` or `query` is specified.", "key": "property", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"value\": \"reference #/components/schemas/User not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/User not found in the OpenAPI spec\"\n }\n]", "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-4d7110b9-b7b0-4abe-9130-1900a070b6ce" }, { "id": "510c0f52-7857-409a-8bb5-9ab67134fab9", "name": "Returned if:\n\n * `accountId`, `query` or `property` is missing.\n * `query` and `accountId` are provided.\n * `property` parameter is not valid.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/rest/api/3/user/search?query=&username=&accountId=&startAt=0&maxResults=50&property=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "search" ], "query": [ { "description": "A query string that is matched against user attributes ( `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 `accountId` or `property` is specified.", "key": "query", "value": "" }, { "key": "username", "value": "" }, { "description": "A query string that is matched exactly against a user `accountId`. Required, unless `query` or `property` is specified.", "key": "accountId", "value": "" }, { "description": "The index of the first item to return in a page of filtered results (page offset).", "key": "startAt", "value": "0" }, { "description": "The maximum number of items to return per page.", "key": "maxResults", "value": "50" }, { "description": "A query string used to search properties. Property keys are specified by path, so property keys containing dot (.) or equals (=) characters cannot be used. The query string cannot be specified using a JSON object. Example: To search for the value of `nested` from `{\"something\":{\"nested\":1,\"other\":2}}` use `thepropertykey.something.nested=1`. Required, unless `accountId` or `query` is specified.", "key": "property", "value": "" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-510c0f52-7857-409a-8bb5-9ab67134fab9" }, { "id": "9e759fe0-eba5-4cff-a055-a65c89747319", "name": "Returned if the authentication credentials are incorrect or missing.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/rest/api/3/user/search?query=&username=&accountId=&startAt=0&maxResults=50&property=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "search" ], "query": [ { "description": "A query string that is matched against user attributes ( `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 `accountId` or `property` is specified.", "key": "query", "value": "" }, { "key": "username", "value": "" }, { "description": "A query string that is matched exactly against a user `accountId`. Required, unless `query` or `property` is specified.", "key": "accountId", "value": "" }, { "description": "The index of the first item to return in a page of filtered results (page offset).", "key": "startAt", "value": "0" }, { "description": "The maximum number of items to return per page.", "key": "maxResults", "value": "50" }, { "description": "A query string used to search properties. Property keys are specified by path, so property keys containing dot (.) or equals (=) characters cannot be used. The query string cannot be specified using a JSON object. Example: To search for the value of `nested` from `{\"something\":{\"nested\":1,\"other\":2}}` use `thepropertykey.something.nested=1`. Required, unless `accountId` or `query` is specified.", "key": "property", "value": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-9e759fe0-eba5-4cff-a055-a65c89747319" }, { "id": "357ffaa7-0ef1-451a-ac98-fa442be5b236", "name": "Returned 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.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/rest/api/3/user/search?query=&username=&accountId=&startAt=0&maxResults=50&property=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "search" ], "query": [ { "description": "A query string that is matched against user attributes ( `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 `accountId` or `property` is specified.", "key": "query", "value": "" }, { "key": "username", "value": "" }, { "description": "A query string that is matched exactly against a user `accountId`. Required, unless `query` or `property` is specified.", "key": "accountId", "value": "" }, { "description": "The index of the first item to return in a page of filtered results (page offset).", "key": "startAt", "value": "0" }, { "description": "The maximum number of items to return per page.", "key": "maxResults", "value": "50" }, { "description": "A query string used to search properties. Property keys are specified by path, so property keys containing dot (.) or equals (=) characters cannot be used. The query string cannot be specified using a JSON object. Example: To search for the value of `nested` from `{\"something\":{\"nested\":1,\"other\":2}}` use `thepropertykey.something.nested=1`. Required, unless `accountId` or `query` is specified.", "key": "property", "value": "" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-357ffaa7-0ef1-451a-ac98-fa442be5b236" } ], "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-00010aea-f97b-41a2-8c7d-a28c144da4c8" } ], "id": "f7a76b9e-fe0e-49c3-b3fa-f7eb5824233d", "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-f7a76b9e-fe0e-49c3-b3fa-f7eb5824233d" }, { "name": "viewissue", "item": [ { "name": "search", "item": [ { "name": "Atlassian Find Users With Browse Permission", "id": "e88205c3-9f89-4b00-9db3-d69c1d765025", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rest/api/3/user/viewissue/search?query=&username=&accountId=&issueKey=&projectKey=&startAt=0&maxResults=50", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "viewissue", "search" ], "query": [ { "description": "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 `accountId` is specified.", "key": "query", "value": "" }, { "description": "This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", "key": "username", "value": "" }, { "description": "A query string that is matched exactly against user `accountId`. Required, unless `query` is specified.", "key": "accountId", "value": "" }, { "description": "The issue key for the issue. Required, unless `projectKey` is specified.", "key": "issueKey", "value": "" }, { "description": "The project key for the project (case sensitive). Required, unless `issueKey` is specified.", "key": "projectKey", "value": "" }, { "description": "The index of the first item to return in a page of results (page offset).", "key": "startAt", "value": "0" }, { "description": "The maximum number of items to return per page.", "key": "maxResults", "value": "50" } ] }, "description": "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](#api-rest-api-3-users-search-get) 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](https://developer.atlassian.com/cloud/jira/platform/profile-visibility/) for more details.

This operation can be accessed anonymously.

**[Permissions](#permissions) required:** *Browse users and groups* [global permission](https://confluence.atlassian.com/x/x4dKLg). Anonymous calls and calls by users without the required permission return empty search results." }, "response": [ { "id": "cc484ff5-3947-42ad-9ca8-4af649152a00", "name": "Returned if the request is successful.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rest/api/3/user/viewissue/search?query=&username=&accountId=&issueKey=&projectKey=&startAt=0&maxResults=50", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "viewissue", "search" ], "query": [ { "description": "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 `accountId` is specified.", "key": "query", "value": "" }, { "description": "This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", "key": "username", "value": "" }, { "description": "A query string that is matched exactly against user `accountId`. Required, unless `query` is specified.", "key": "accountId", "value": "" }, { "description": "The issue key for the issue. Required, unless `projectKey` is specified.", "key": "issueKey", "value": "" }, { "description": "The project key for the project (case sensitive). Required, unless `issueKey` is specified.", "key": "projectKey", "value": "" }, { "description": "The index of the first item to return in a page of results (page offset).", "key": "startAt", "value": "0" }, { "description": "The maximum number of items to return per page.", "key": "maxResults", "value": "50" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"value\": \"reference #/components/schemas/User not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/User not found in the OpenAPI spec\"\n }\n]", "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-cc484ff5-3947-42ad-9ca8-4af649152a00" }, { "id": "33f291b2-9dc5-486f-a98c-69440079507a", "name": "Returned if:\n\n * `issueKey` or `projectKey` is missing.\n * `query` or `accountId` is missing.\n * `query` and `accountId` are provided.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/rest/api/3/user/viewissue/search?query=&username=&accountId=&issueKey=&projectKey=&startAt=0&maxResults=50", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "viewissue", "search" ], "query": [ { "description": "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 `accountId` is specified.", "key": "query", "value": "" }, { "description": "This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", "key": "username", "value": "" }, { "description": "A query string that is matched exactly against user `accountId`. Required, unless `query` is specified.", "key": "accountId", "value": "" }, { "description": "The issue key for the issue. Required, unless `projectKey` is specified.", "key": "issueKey", "value": "" }, { "description": "The project key for the project (case sensitive). Required, unless `issueKey` is specified.", "key": "projectKey", "value": "" }, { "description": "The index of the first item to return in a page of results (page offset).", "key": "startAt", "value": "0" }, { "description": "The maximum number of items to return per page.", "key": "maxResults", "value": "50" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-33f291b2-9dc5-486f-a98c-69440079507a" }, { "id": "ab066d42-ecc0-47e3-a444-6b100a417c85", "name": "Returned if the authentication credentials are incorrect or missing.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/rest/api/3/user/viewissue/search?query=&username=&accountId=&issueKey=&projectKey=&startAt=0&maxResults=50", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "viewissue", "search" ], "query": [ { "description": "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 `accountId` is specified.", "key": "query", "value": "" }, { "description": "This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", "key": "username", "value": "" }, { "description": "A query string that is matched exactly against user `accountId`. Required, unless `query` is specified.", "key": "accountId", "value": "" }, { "description": "The issue key for the issue. Required, unless `projectKey` is specified.", "key": "issueKey", "value": "" }, { "description": "The project key for the project (case sensitive). Required, unless `issueKey` is specified.", "key": "projectKey", "value": "" }, { "description": "The index of the first item to return in a page of results (page offset).", "key": "startAt", "value": "0" }, { "description": "The maximum number of items to return per page.", "key": "maxResults", "value": "50" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-ab066d42-ecc0-47e3-a444-6b100a417c85" }, { "id": "2346f3bf-ae17-4bdb-908a-e52f7311e7c6", "name": "Returned if the issue or project is not found.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/rest/api/3/user/viewissue/search?query=&username=&accountId=&issueKey=&projectKey=&startAt=0&maxResults=50", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "viewissue", "search" ], "query": [ { "description": "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 `accountId` is specified.", "key": "query", "value": "" }, { "description": "This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", "key": "username", "value": "" }, { "description": "A query string that is matched exactly against user `accountId`. Required, unless `query` is specified.", "key": "accountId", "value": "" }, { "description": "The issue key for the issue. Required, unless `projectKey` is specified.", "key": "issueKey", "value": "" }, { "description": "The project key for the project (case sensitive). Required, unless `issueKey` is specified.", "key": "projectKey", "value": "" }, { "description": "The index of the first item to return in a page of results (page offset).", "key": "startAt", "value": "0" }, { "description": "The maximum number of items to return per page.", "key": "maxResults", "value": "50" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-2346f3bf-ae17-4bdb-908a-e52f7311e7c6" }, { "id": "9db079f3-21a7-4845-907a-178e6367a204", "name": "Returned 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.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/rest/api/3/user/viewissue/search?query=&username=&accountId=&issueKey=&projectKey=&startAt=0&maxResults=50", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "3", "user", "viewissue", "search" ], "query": [ { "description": "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 `accountId` is specified.", "key": "query", "value": "" }, { "description": "This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", "key": "username", "value": "" }, { "description": "A query string that is matched exactly against user `accountId`. Required, unless `query` is specified.", "key": "accountId", "value": "" }, { "description": "The issue key for the issue. Required, unless `projectKey` is specified.", "key": "issueKey", "value": "" }, { "description": "The project key for the project (case sensitive). Required, unless `issueKey` is specified.", "key": "projectKey", "value": "" }, { "description": "The index of the first item to return in a page of results (page offset).", "key": "startAt", "value": "0" }, { "description": "The maximum number of items to return per page.", "key": "maxResults", "value": "50" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-9db079f3-21a7-4845-907a-178e6367a204" } ], "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-e88205c3-9f89-4b00-9db3-d69c1d765025" } ], "id": "eccabb69-a31c-4ca7-a103-0e3f5781ad51", "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-eccabb69-a31c-4ca7-a103-0e3f5781ad51" } ], "id": "1da7aa65-6013-4f14-9ce5-a5c1362d7213", "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-1da7aa65-6013-4f14-9ce5-a5c1362d7213" } ], "id": "8186a471-9e66-40f5-8da3-26e0bda3c4f2", "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-8186a471-9e66-40f5-8da3-26e0bda3c4f2" } ], "id": "d5008198-2816-48b7-9879-c4a62bf71b8b", "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-d5008198-2816-48b7-9879-c4a62bf71b8b" } ], "id": "3f6990e5-9f55-445d-8e35-6dd85d0fefaf", "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-3f6990e5-9f55-445d-8e35-6dd85d0fefaf" } ], "id": "02fe851f-61c3-40f6-8574-efac74700eeb", "createdAt": "2026-06-05T15:08:57.000Z", "updatedAt": "2026-06-05T15:08:57.000Z", "uid": "35240-02fe851f-61c3-40f6-8574-efac74700eeb" } ], "variable": [ { "key": "baseUrl", "value": "https://your-domain.atlassian.net" } ] }