- Announcement banner
- Issue custom field values (apps)
- Issue custom field configuration (apps)
- Jira settings
- Application roles
- Issue attachments
- Audit records
- Avatars
- Issue comments
- Issue comment properties
- Project components
- Time tracking
- Issue custom field options
- Dashboards
- Get all dashboards
- Create dashboard
- Get available gadgets
- Search for dashboards
- Get gadgets
- Add gadget to dashboard
- Update gadget on dashboard
- Remove gadget from dashboard
- Get dashboard item property keys
- Get dashboard item property
- Set dashboard item property
- Delete dashboard item property
- Get dashboard
- Update dashboard
- Delete dashboard
- Copy dashboard
- Issues
- Jira expressions
- Issue fields
- Issue custom field contexts
- Get custom field contexts
- Create custom field context
- Get custom field contexts default values
- Set custom field contexts default values
- Get issue types for custom field context
- Get custom field contexts for projects and issue types
- Get project mappings for custom field context
- Update custom field context
- Delete custom field context
- Add issue types to context
- Remove issue types from context
- Assign custom field context to projects
- Remove custom field context from projects
- Screens
- Issue custom field options (apps)
- Issue field configurations
- Get all field configurations
- Create field configuration
- Update field configuration
- Delete field configuration
- Get field configuration items
- Update field configuration items
- Get all field configuration schemes
- Create field configuration scheme
- Get field configuration issue type items
- Get field configuration schemes for projects
- Assign field configuration scheme to project
- Update field configuration scheme
- Delete field configuration scheme
- Assign issue types to field configurations
- Remove issue types from field configuration scheme
- Filters
- Filter sharing
- Groups
- Group and user picker
- License metrics
- Issue search
- Issue properties
- Issue watchers
- Issue remote links
- Issue votes
- Issue worklogs
- Issue worklog properties
- Issue links
- Issue link types
- Issue security schemes
- Get issue security schemes
- Create issue security scheme
- Get issue security levels
- Set default issue security levels
- Get issue security level members
- Get projects using issue security schemes
- Associate security scheme to project
- Search issue security schemes
- Get issue security scheme
- Update issue security scheme
- Delete issue security scheme
- Add issue security levels
- Update issue security level
- Remove issue security level
- Add issue security level members
- Remove member from issue security level
- Issue security level
- Issue types
- Issue type properties
- Issue type schemes
- Issue type screen schemes
- Get issue type screen schemes
- Create issue type screen scheme
- Get issue type screen scheme items
- Get issue type screen schemes for projects
- Assign issue type screen scheme to project
- Update issue type screen scheme
- Delete issue type screen scheme
- Append mappings to issue type screen scheme
- Update issue type screen scheme default screen scheme
- Remove mappings from issue type screen scheme
- Get issue type screen scheme projects
- JQL
- JQL functions (apps)
- Labels
- Permissions
- Myself
- Issue notification schemes
- Permission schemes
- Issue priorities
- Projects
- Project types
- Project avatars
- Project features
- Project properties
- Project roles
- Project role actors
- Project versions
- Project email
- Project permission schemes
- Project categories
- Project key and name validation
- Issue resolutions
- Screen tabs
- Screen tab fields
- Screen schemes
- Server info
- Issue navigator settings
- Workflow statuses
- Workflow status categories
- Status
- Tasks
- UI modifications (apps)
- Users
- User search
- User properties
- Webhooks
- Workflows
- Workflow transition rules
- Workflow transition properties
- Workflow schemes
- Get all workflow schemes
- Create workflow scheme
- Get workflow scheme
- Update workflow scheme
- Delete workflow scheme
- Get default workflow
- Update default workflow
- Delete default workflow
- Get workflow for issue type in workflow scheme
- Set workflow for issue type in workflow scheme
- Delete workflow for issue type in workflow scheme
- Get issue types for workflows in workflow scheme
- Set issue types for workflow in workflow scheme
- Delete issue types for workflow in workflow scheme
- Workflow scheme project associations
- Workflow scheme drafts
- Create draft workflow scheme
- Get draft workflow scheme
- Update draft workflow scheme
- Delete draft workflow scheme
- Get draft default workflow
- Update draft default workflow
- Delete draft default workflow
- Get workflow for issue type in draft workflow scheme
- Set workflow for issue type in draft workflow scheme
- Delete workflow for issue type in draft workflow scheme
- Publish draft workflow scheme
- Get issue types for workflows in draft workflow scheme
- Set issue types for workflow in workflow scheme
- Delete issue types for workflow in draft workflow scheme
- App properties
- Dynamic modules
- App migration
Find users by query
GET
/rest/api/3/user/search/query
startAt and maxResults, up to the thousandth user, and then returns only the users from that range that match the structured query. This means the operation usually returns fewer users than specified in maxResults. To get all the users who match the structured query, use Get all users and filter the records in your code.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.AND and OR operators to form more complex queries. For example:is assignee of PROJ AND [propertyKey].entity.property.path is "property value"Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'http://jira.local:8080/jira/rest//rest/api/3/user/search/query?query='Response Response Example
200 - Example 1
{
"isLast": true,
"maxResults": 0,
"nextPage": "http://example.com",
"self": "http://example.com",
"startAt": 0,
"total": 0,
"values": [
{}
]
}Request
Query Params
query
stringÂ
required
startAt
integerÂ
optional
maxResults
integerÂ
optional
Responses
🟢200Returned if the request is successful.
application/json
Body
A page of items.
isLast
booleanÂ
read-onlyoptional
maxResults
integer <int32>
read-onlyoptional
nextPage
string <uri>
read-onlyoptional
self
string <uri>
read-onlyoptional
startAt
integer <int64>
read-onlyoptional
total
integer <int64>
read-onlyoptional
values
array [object]Â
read-onlyoptional
🟠400Returned if the query is invalid.
🟠401Returned if the authentication credentials are incorrect or missing.
🟠403Returned if the user does not have the necessary permission.
🟠408Returned if the search is timed out.
Modified at 2023-07-13 03:27:27