Jira
Jira is a software development tool for agile teams to plan, track, and release world-class software. Connecting Jira issues to the rest of your tools helps break down barriers and unleash the potential of your team.
This connector is available in the following products and regions:
| Service | Class | Regions |
|---|---|---|
| Logic Apps | Standard | All Logic Apps regions except the following: - Azure China regions - US Department of Defense (DoD) |
| Power Automate | Premium | All Power Automate regions except the following: - China Cloud operated by 21Vianet |
| Power Apps | Premium | All Power Apps regions except the following: - China Cloud operated by 21Vianet |
| Contact | |
|---|---|
| Name | Microsoft |
| URL | Microsoft LogicApps Support Microsoft Power Automate Support Microsoft Power Apps Support |
| Connector Metadata | |
|---|---|
| Publisher | Microsoft |
| Website | https://www.atlassian.com/software/jira |
| Privacy policy | https://www.atlassian.com/legal/privacy-policy |
| Categories | IT Operations;Collaboration |
To use this integration, you will need a Jira account.
Known Issues and Limitations
- For authentication, you need to use an API token. To get a token, go to this link.
- Basic authentication with passwords is deprecated. For more information, see jira API documentation.
- Jira Server behind a firewall or with REST API disabled is not supported.
- When creating a connection to Jira Cloud, you need to use a valid email address for username. Otherwise, the connection will not be established, although it looks like it's successful.
- Usernames in Jira Cloud are deprecated and cannot be used anymore for fields such as Reporter. For more information, see Atlassian Cloud documentation.
- As per the Jira API documentation, jira API returns maximum 50 projects, so top 50 projects will be listed under dropdown in actions/triggers.
- Pagination was implemented on Get projects. It will return all projects.
- The Create a new issue (V2) action supports only simple field types such as 'string', 'number', 'date', and 'datetime' in the dynamic schema. If project configuration has a required fields of complex data types, the operation will fail with the error: "Field '{key}' of type '{type}' is not supported". To workaround this, please change project fields configuration and make these fields not required.
- The Create a new issue (V3) action supports only simple field types such as 'string', 'number', 'date', and 'datetime' in the dynamic schema. If project configuration has a required fields of complex data types, the operation will fail with the error: "Field '{key}' of type '{type}' is not supported". To workaround this, please change project fields configuration and make these fields not required.
- The
Projectproperty expected by the connector's actions and triggers should be filled using one of the following options:- Pick a project from the project picker. Note that Jira Cloud connections show only top 50 projects in the picker.
- Use an output from the Get projects action (project's
Project Keyproperty).
- For more Edit Issue operation details please see Jira API documentation
- When a working flow starts failing with a 400 response or a bad request for any action or trigger, please check if the API key used to create the connection is expired and if so, re-create connection with a new API key.
Creating a connection
The connector supports the following authentication types:
| API Token | Use API Token to access Jira | All regions | Not shareable |
| Oauth | Use Oauth to access Jira. | All regions | Not shareable |
| Default [DEPRECATED] | This option is only for older connections without an explicit authentication type, and is only provided for backward compatibility. | All regions | Not shareable |
API Token
Auth ID: APIToken
Applicable: All regions
Use API Token to access Jira
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
| Name | Type | Description | Required |
|---|---|---|---|
| Username or Email | string | Your Jira username. For Jira Cloud you need to use a valid email address. | True |
| API token | securestring | Your API token (https://id.atlassian.com/manage/api-tokens). | True |
Oauth
Auth ID: oauth
Applicable: All regions
Use Oauth to access Jira.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
Default [DEPRECATED]
Applicable: All regions
This option is only for older connections without an explicit authentication type, and is only provided for backward compatibility.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
| Name | Type | Description | Required |
|---|---|---|---|
| Jira instance | string | The url where your Jira instance is hosted (must support https). | True |
| Username or Email | string | Your Jira username. For Jira Cloud you need to use a valid email address. | True |
| API token | securestring | Your API token (https://id.atlassian.com/manage/api-tokens). | True |
Throttling Limits
| Name | Calls | Renewal Period |
|---|---|---|
| API calls per connection | 100 | 60 seconds |
| Frequency of trigger polls | 1 | 60 seconds |
Actions
| Add comment |
This operation is used to add a comment to an existing Jira issue. |
| Add comment (V2) |
This operation is used to add a comment to an existing Jira issue. |
| Cancel Task |
Cancels a task. Permissions required: either of: Administer Jira or Creator of the task. |
| Cancel Task (V2) |
Cancels a task. Permissions required: either of: Administer Jira or Creator of the task. |
| Create a new issue (V2) |
This operation is used to create a new issue. |
| Create a new issue (V3) |
This operation is used to create a new issue. |
| Create a new issue [DEPRECATED] |
This action has been deprecated. Please use Create a new issue (V3) instead.
|
| Create a new project |
This operation is used to create a new Jira project. |
| Create a new project (V2) |
This operation is used to create a new Jira project. |
| Create Project Category |
Creates a project category. Permissions required: Administer Jira (global permissions) |
| Create Project Category (V2) |
Creates a project category. Permissions required: Administer Jira (global permissions) |
| Delete Project |
Deletes a project. Permissions required: Administer Jira (global permissions) |
| Delete Project (V2) |
Deletes a project. Permissions required: Administer Jira (global permissions) |
| Edit Issue |
Edits an issue. A transition may be applied and issue properties updated as part of the edit. The edits to the issue's fields are defined using update and fields. |
| Edit Issue (V2) |
Edits an issue. A transition may be applied and issue properties updated as part of the edit. The edits to the issue's fields are defined using update and fields. |
| Get All Project Categories |
Returns all project categories. |
| Get All Project Categories (V2) |
Returns all project categories. |
| Get current user |
This operation returns details for the current user |
| Get issue by key |
This operation is used to retrieve the issue object for a given issue Key. |
| Get issue by key (V2) |
This operation is used to retrieve the issue object for a given issue Key. |
| Get list of Filters |
This operation returns a list of Filters accessible to user. |
| Get list of Filters (V2) |
This operation returns a list of Filters accessible to user. |
| Get list of issues |
This operation returns a list of issues using JQL. |
| Get list of Resources |
This operation returns a list of resources accessible to user. |
| Get list of Transitions |
Returns a list of the transitions possible for this issue by the current user |
| Get projects |
This operation is used to retrieve a list of projects for your Jira instance. |
| Get projects (V2) |
This operation is used to retrieve a list of projects for your Jira instance. |
| Get projects [DEPRECATED] |
This action has been deprecated. Please use Get projects instead.
|
| Get Task |
Returns the status of a long-running asynchronous task. When a task has finished, this operation returns the JSON blob applicable to the task. |
| Get Task (V2) |
Returns the status of a long-running asynchronous task. When a task has finished, this operation returns the JSON blob applicable to the task. |
| Get User |
Returns a user. Permissions required: Browse users and groups. |
| Get User (V2) |
Returns a user. Permissions required: Browse users and groups. |
| List users by project |
This operation is used to retrieve a list of all users associated with a project. |
| List users by project (V2) |
This operation is used to retrieve a list of all users associated with a project. |
| Performs an issue transition |
Transitions an issue to a new status. |
| Remove Project Category |
Deletes a project category. Permissions required: Administer Jira (global permissions) |
| Remove Project Category (V2) |
Deletes a project category. Permissions required: Administer Jira (global permissions) |
| Update Project |
Updates the project details of a project. |
| Update Project (V2) |
Updates the project details of a project. |
Add comment
This operation is used to add a comment to an existing Jira issue.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Issue Key
|
issueKey | True | string |
Unique Key of the issue to add a comment to. |
|
Comment
|
body | True | string |
Body of the comment. |
Returns
- Body
- CommentResponse
Add comment (V2)
This operation is used to add a comment to an existing Jira issue.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Jira instance
|
X-Request-Jirainstance | True | string |
The url where your Jira instance is hosted (must support https). |
|
Issue Key
|
issueKey | True | string |
Unique Key of the issue to add a comment to. |
|
Comment
|
body | True | string |
Body of the comment. |
Returns
- Body
- CommentResponse
Cancel Task
Cancels a task. Permissions required: either of: Administer Jira or Creator of the task.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Task ID
|
taskId | True | string |
The ID of the task. |
Returns
Cancel Task (V2)
Cancels a task. Permissions required: either of: Administer Jira or Creator of the task.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Jira instance
|
X-Request-Jirainstance | True | string |
The url where your Jira instance is hosted (must support https). |
|
Task ID
|
taskId | True | string |
The ID of the task. |
Returns
Create a new issue (V2)
This operation is used to create a new issue.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Project
|
projectKey | True | string |
Pick a project to create the issue in. |
|
Issue Type Id
|
issueTypeIds | True | string |
Pick an issue type. |
|
item
|
item | dynamic |
Item |
Returns
- Body
- CreateIssueResponse
Create a new issue (V3)
This operation is used to create a new issue.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Jira instance
|
X-Request-Jirainstance | True | string |
The url where your Jira instance is hosted (must support https). |
|
Project
|
projectKey | True | string |
Pick a project to create the issue in. |
|
Issue Type Id
|
issueTypeIds | True | string |
Pick an issue type. |
|
item
|
item | dynamic |
Item |
Returns
- Body
- CreateIssueResponse
Create a new issue [DEPRECATED]
This action has been deprecated. Please use Create a new issue (V3) instead.
This operation is used to create a new issue.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Project
|
projectKey | True | string |
Pick a project to create the issue in. |
|
Issue Type Id
|
id | True | string |
Pick an issue type. |
|
Summary
|
summary | True | string |
Brief description of the issue. |
|
Components
|
components | string |
A system field that is multiple values addressed by 'name' (e.g. Microsoft Entra ID, Network Switch). |
|
|
Reporter Id
|
id | string |
Person reporting the issue. |
|
|
Description
|
description | string |
A detailed description of the issue. |
|
|
Priority Id
|
id | string |
Pick a priority for the issue. |
|
|
Labels
|
labels | string |
Enter a comma separated list of labels |
|
|
Assignee Id
|
id | string |
Agent the issue is assigned to. |
|
|
Parent Issue Id
|
id | string |
Set the parent for a sub-task. |
|
|
Epic Name (customfield_10011)
|
customfield_10119 | string |
Epic name is required for epic issue type. This field matches 'customfield_10011' field on Jira server. |
Returns
- Body
- CreateIssueResponse
Create a new project
This operation is used to create a new Jira project.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Project Key
|
key | True | string |
The unique key, starts with a capital letter. |
|
Name
|
name | True | string |
Title of the project. |
|
Type
|
projectTypeKey | True | string |
Project type key. |
|
Lead Id
|
leadAccountId | True | string |
Id of Project lead. |
|
Description
|
description | string |
Verbose description of the project. |
Returns
Create a new project (V2)
This operation is used to create a new Jira project.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Jira instance
|
X-Request-Jirainstance | True | string |
The url where your Jira instance is hosted (must support https). |
|
Project Key
|
key | True | string |
The unique key, starts with a capital letter. |
|
Name
|
name | True | string |
Title of the project. |
|
Type
|
projectTypeKey | True | string |
Project type key. |
|
Lead Id
|
leadAccountId | True | string |
Id of Project lead. |
|
Description
|
description | string |
Verbose description of the project. |
Returns
Create Project Category
Creates a project category. Permissions required: Administer Jira (global permissions)
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
name
|
name | string |
Name |
|
|
description
|
description | string |
Description |
Returns
Create Project Category (V2)
Creates a project category. Permissions required: Administer Jira (global permissions)
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Jira instance
|
X-Request-Jirainstance | True | string |
The url where your Jira instance is hosted (must support https). |
|
name
|
name | string |
Name |
|
|
description
|
description | string |
Description |
Returns
Delete Project
Deletes a project. Permissions required: Administer Jira (global permissions)
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Project ID or Key
|
projectIdOrKey | True | string |
The project ID or project key (case sensitive). |
|
Enable Undo
|
enableUndo | boolean |
Whether this project is placed in the Jira recycle bin where it will be available for restoration. |
Delete Project (V2)
Deletes a project. Permissions required: Administer Jira (global permissions)
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Jira instance
|
X-Request-Jirainstance | True | string |
The url where your Jira instance is hosted (must support https). |
|
Project ID or Key
|
projectIdOrKey | True | string |
The project ID or project key (case sensitive). |
|
Enable Undo
|
enableUndo | boolean |
Whether this project is placed in the Jira recycle bin where it will be available for restoration. |
Edit Issue
Edits an issue. A transition may be applied and issue properties updated as part of the edit. The edits to the issue's fields are defined using update and fields.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Issue ID or Key
|
issueIdOrKey | True | string |
Provide the Issue ID or Key for the issue you wish to edit |
|
Notify Users
|
notifyUsers | boolean |
Do you want to notify users? |
|
|
Override Screen Security
|
overrideScreenSecurity | boolean |
Do you want to override the screen security? |
|
|
Override Editable Flag
|
overrideEditableFlag | boolean |
Do you want to override the editable flag? |
|
|
Transition ID
|
id | string |
Transition ID |
|
|
Transition looped
|
looped | string |
Transition looped |
|
|
Fields
|
fields | object |
List of issue screen fields to update, specifying the sub-field to update and its value for each field. This field provides a straightforward option when setting a sub-field. When multiple sub-fields or other operations are required, use update. Fields included in here cannot be included in update. |
|
|
Update
|
update | object |
A Map containing the field field name and a list of operations to perform on the issue screen field. Note that fields included in here cannot be included in fields. |
|
|
Metadata type
|
type | string |
History metadata type |
|
|
Metadata description
|
description | string |
History metadata description |
|
|
Metadata description key
|
descriptionKey | string |
History metadata description key |
|
|
Metadata activity description
|
activityDescription | string |
History metadata activity description |
|
|
Metadata activity description key
|
activityDescriptionKey | string |
History metadata activity description key |
|
|
Metadata email description
|
emailDescription | string |
History metadata email description |
|
|
Metadata email description key
|
emailDescriptionKey | string |
History metadata email description key |
|
|
Actor ID
|
id | string |
Actor ID |
|
|
Actor display name
|
displayName | string |
Actor display name |
|
|
Actor display name key
|
displayNameKey | string |
Actor display name key |
|
|
Actor type
|
type | string |
Actor type |
|
|
Actor avatar url
|
avatarUrl | string |
Actor avatar url |
|
|
Actor url
|
url | string |
Actor url |
|
|
Generator id
|
id | string |
Generator id |
|
|
Generator display name
|
displayName | string |
Generator display name |
|
|
Generator display name key
|
displayNameKey | string |
Generator display name key |
|
|
Generator type
|
type | string |
Generator type |
|
|
Generator avatar url
|
avatarUrl | string |
Generator avatar url |
|
|
Generator url
|
url | string |
Generator url |
|
|
Cause id
|
id | string |
Cause id |
|
|
Cause display name
|
displayName | string |
Cause display name |
|
|
Cause display name key
|
displayNameKey | string |
Cause display name key |
|
|
Cause type
|
type | string |
Cause type |
|
|
Cause avatar url
|
avatarUrl | string |
Cause avatar url |
|
|
Cause url
|
url | string |
Cause url |
|
|
Extra data
|
extraData | string |
Extra data |
|
|
key
|
key | string |
Key |
Returns
Edit Issue (V2)
Edits an issue. A transition may be applied and issue properties updated as part of the edit. The edits to the issue's fields are defined using update and fields.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Jira instance
|
X-Request-Jirainstance | True | string |
The url where your Jira instance is hosted (must support https). |
|
Issue ID or Key
|
issueIdOrKey | True | string |
Provide the Issue ID or Key for the issue you wish to edit |
|
Notify Users
|
notifyUsers | boolean |
Do you want to notify users? |
|
|
Override Screen Security
|
overrideScreenSecurity | boolean |
Do you want to override the screen security? |
|
|
Override Editable Flag
|
overrideEditableFlag | boolean |
Do you want to override the editable flag? |
|
|
Transition ID
|
id | string |
Transition ID |
|
|
Transition looped
|
looped | string |
Transition looped |
|
|
Fields
|
fields | object |
List of issue screen fields to update, specifying the sub-field to update and its value for each field. This field provides a straightforward option when setting a sub-field. When multiple sub-fields or other operations are required, use update. Fields included in here cannot be included in update. |
|
|
Update
|
update | object |
A Map containing the field field name and a list of operations to perform on the issue screen field. Note that fields included in here cannot be included in fields. |
|
|
Metadata type
|
type | string |
History metadata type |
|
|
Metadata description
|
description | string |
History metadata description |
|
|
Metadata description key
|
descriptionKey | string |
History metadata description key |
|
|
Metadata activity description
|
activityDescription | string |
History metadata activity description |
|
|
Metadata activity description key
|
activityDescriptionKey | string |
History metadata activity description key |
|
|
Metadata email description
|
emailDescription | string |
History metadata email description |
|
|
Metadata email description key
|
emailDescriptionKey | string |
History metadata email description key |
|
|
Actor ID
|
id | string |
Actor ID |
|
|
Actor display name
|
displayName | string |
Actor display name |
|
|
Actor display name key
|
displayNameKey | string |
Actor display name key |
|
|
Actor type
|
type | string |
Actor type |
|
|
Actor avatar url
|
avatarUrl | string |
Actor avatar url |
|
|
Actor url
|
url | string |
Actor url |
|
|
Generator id
|
id | string |
Generator id |
|
|
Generator display name
|
displayName | string |
Generator display name |
|
|
Generator display name key
|
displayNameKey | string |
Generator display name key |
|
|
Generator type
|
type | string |
Generator type |
|
|
Generator avatar url
|
avatarUrl | string |
Generator avatar url |
|
|
Generator url
|
url | string |
Generator url |
|
|
Cause id
|
id | string |
Cause id |
|
|
Cause display name
|
displayName | string |
Cause display name |
|
|
Cause display name key
|
displayNameKey | string |
Cause display name key |
|
|
Cause type
|
type | string |
Cause type |
|
|
Cause avatar url
|
avatarUrl | string |
Cause avatar url |
|
|
Cause url
|
url | string |
Cause url |
|
|
Extra data
|
extraData | string |
Extra data |
|
|
key
|
key | string |
Key |
Returns
Get All Project Categories
Returns all project categories.
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
|
array of object | ||
|
self
|
self | string |
Self |
|
id
|
id | string |
ID |
|
description
|
description | string |
Description |
|
name
|
name | string |
Name |
Get All Project Categories (V2)
Returns all project categories.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Jira instance
|
X-Request-Jirainstance | True | string |
The url where your Jira instance is hosted (must support https). |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
|
array of object | ||
|
self
|
self | string |
Self |
|
id
|
id | string |
ID |
|
description
|
description | string |
Description |
|
name
|
name | string |
Name |
Get current user
This operation returns details for the current user
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Jira instance
|
X-Request-Jirainstance | True | string |
The url where your Jira instance is hosted (must support https). |
|
Expand
|
expand | string |
Use expand to include additional information about users in the response. This parameter accepts a comma-separated list. Expand options include: * |
Returns
Get issue by key
This operation is used to retrieve the issue object for a given issue Key.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Issue Key
|
issueKey | True | string |
Unique Key of the issue. |
Returns
- Issue
- FullIssue
Get issue by key (V2)
This operation is used to retrieve the issue object for a given issue Key.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Jira instance
|
X-Request-Jirainstance | True | string |
The url where your Jira instance is hosted (must support https). |
|
Issue Key
|
issueKey | True | string |
Unique Key of the issue. |
Returns
- Issue
- FullIssue
Get list of Filters
Get list of Filters (V2)
This operation returns a list of Filters accessible to user.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Jira instance
|
X-Request-Jirainstance | True | string |
The url where your Jira instance is hosted (must support https). |
Returns
- Body
- ListFiltersResponse
Get list of issues
This operation returns a list of issues using JQL.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Jira instance
|
X-Request-Jirainstance | True | string |
The url where your Jira instance is hosted (must support https). |
Returns
- Body
- ListIssuesResponse
Get list of Resources
Get list of Transitions
Returns a list of the transitions possible for this issue by the current user
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Jira instance
|
X-Request-Jirainstance | True | string |
The url where your Jira instance is hosted (must support https). |
|
Issue ID or Key
|
issueIdOrKey | True | string |
ID or key of the issue to retrieve transitions for |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
transitions
|
transitions | array of Transition |
Get projects
This operation is used to retrieve a list of projects for your Jira instance.
Returns
Get projects (V2)
This operation is used to retrieve a list of projects for your Jira instance.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Jira instance
|
X-Request-Jirainstance | True | string |
The url where your Jira instance is hosted (must support https). |
Returns
Get projects [DEPRECATED]
This action has been deprecated. Please use Get projects instead.
This operation is used to retrieve a list of projects for your Jira instance.
Returns
- Items
- ProjectArray
Get Task
Returns the status of a long-running asynchronous task. When a task has finished, this operation returns the JSON blob applicable to the task.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Task ID
|
taskId | True | string |
The ID of the task. |
Returns
Get Task (V2)
Returns the status of a long-running asynchronous task. When a task has finished, this operation returns the JSON blob applicable to the task.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Jira instance
|
X-Request-Jirainstance | True | string |
The url where your Jira instance is hosted (must support https). |
|
Task ID
|
taskId | True | string |
The ID of the task. |
Returns
Get User
Returns a user. Permissions required: Browse users and groups.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Account ID
|
accountId | True | string |
The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. Required. |
|
Expand
|
expand | string |
Use expand to include additional information about users in the response. This parameter accepts a comma-separated list. Expand options include: * |
Returns
Get User (V2)
Returns a user. Permissions required: Browse users and groups.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Jira instance
|
X-Request-Jirainstance | True | string |
The url where your Jira instance is hosted (must support https). |
|
Account ID
|
accountId | True | string |
The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. Required. |
|
Expand
|
expand | string |
Use expand to include additional information about users in the response. This parameter accepts a comma-separated list. Expand options include: * |
Returns
List users by project
This operation is used to retrieve a list of all users associated with a project.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Project key
|
projectKey | True | string |
Unique key of the project. |
Returns
- Items
- UserList
List users by project (V2)
This operation is used to retrieve a list of all users associated with a project.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Jira instance
|
X-Request-Jirainstance | True | string |
The url where your Jira instance is hosted (must support https). |
|
Project key
|
projectKey | True | string |
Unique key of the project. |
Returns
- Items
- UserList
Performs an issue transition
Transitions an issue to a new status.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Jira instance
|
X-Request-Jirainstance | True | string |
The url where your Jira instance is hosted (must support https). |
|
Issue ID or Key
|
issueIdOrKey | True | string |
ID or key of the issue to be transitioned |
|
name
|
name | string | ||
|
name
|
name | string | ||
|
activityDescription
|
activityDescription | string | ||
|
avatarUrl
|
avatarUrl | string | ||
|
displayName
|
displayName | string | ||
|
id
|
id | string | ||
|
type
|
type | string | ||
|
url
|
url | string | ||
|
id
|
id | string | ||
|
type
|
type | string | ||
|
description
|
description | string | ||
|
Iteration
|
Iteration | string | ||
|
Step
|
Step | string | ||
|
id
|
id | string | ||
|
type
|
type | string | ||
|
type
|
type | string | ||
|
id
|
id | string | ||
|
body
|
body | string |
Returns
Remove Project Category
Deletes a project category. Permissions required: Administer Jira (global permissions)
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Project ID
|
id | True | integer |
ID of the project category to delete. |
Remove Project Category (V2)
Deletes a project category. Permissions required: Administer Jira (global permissions)
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Jira instance
|
X-Request-Jirainstance | True | string |
The url where your Jira instance is hosted (must support https). |
|
Project ID
|
id | True | integer |
ID of the project category to delete. |
Update Project
Updates the project details of a project.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Project ID or Key
|
projectIdOrKey | True | string |
Provide the project ID or Key you want to update1 |
|
key
|
key | string |
Key |
|
|
name
|
name | string |
Name |
|
|
projectTypeKey
|
projectTypeKey | string |
Project Type Key |
|
|
projectTemplateKey
|
projectTemplateKey | string |
Project Template Key |
|
|
description
|
description | string |
Description |
|
|
lead
|
lead | string |
Lead |
|
|
leadAccountId
|
leadAccountId | string |
Lead Account ID |
|
|
url
|
url | string |
URL |
|
|
assigneeType
|
assigneeType | string |
Assignee Type |
|
|
avatarId
|
avatarId | string |
Avatar ID |
|
|
issueSecurityScheme
|
issueSecurityScheme | string |
Issue Security Scheme |
|
|
permissionScheme
|
permissionScheme | string |
Permission Scheme |
|
|
notificationScheme
|
notificationScheme | string |
Notification Scheme |
|
|
categoryId
|
categoryId | string |
Category ID |
Returns
Update Project (V2)
Updates the project details of a project.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Jira instance
|
X-Request-Jirainstance | True | string |
The url where your Jira instance is hosted (must support https). |
|
Project ID or Key
|
projectIdOrKey | True | string |
Provide the project ID or Key you want to update1 |
|
key
|
key | string |
Key |
|
|
name
|
name | string |
Name |
|
|
projectTypeKey
|
projectTypeKey | string |
Project Type Key |
|
|
projectTemplateKey
|
projectTemplateKey | string |
Project Template Key |
|
|
description
|
description | string |
Description |
|
|
lead
|
lead | string |
Lead |
|
|
leadAccountId
|
leadAccountId | string |
Lead Account ID |
|
|
url
|
url | string |
URL |
|
|
assigneeType
|
assigneeType | string |
Assignee Type |
|
|
avatarId
|
avatarId | string |
Avatar ID |
|
|
issueSecurityScheme
|
issueSecurityScheme | string |
Issue Security Scheme |
|
|
permissionScheme
|
permissionScheme | string |
Permission Scheme |
|
|
notificationScheme
|
notificationScheme | string |
Notification Scheme |
|
|
categoryId
|
categoryId | string |
Category ID |
Returns
Triggers
| When a new issue is created |
This operation triggers when a new issue is added to the given project. |
| When a new issue is created (V2) |
This operation triggers when a new issue is added to the given project. |
| When a new issue is returned by a JQL query |
This operation triggers when a new issue appears in the latest 100 results of a JQL query. |
| When a new issue is returned by a JQL query (V2) |
This operation triggers when a new issue appears in the latest 100 results of a JQL query. |
| When an issue is closed |
This operation triggers when an existing issue is closed in the given project. |
| When an issue is closed (V2) |
This operation triggers when an existing issue is closed in the given project. |
When a new issue is created
This operation triggers when a new issue is added to the given project.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Project
|
projectKey | True | string |
Unique key of the project to look for new issues. |
Returns
- Issue
- FullIssue
When a new issue is created (V2)
This operation triggers when a new issue is added to the given project.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Jira instance
|
X-Request-Jirainstance | string |
The url where your Jira instance is hosted (must support https). |
|
|
Project
|
projectKey | True | string |
Unique key of the project to look for new issues. |
Returns
- Issue
- FullIssue
When a new issue is returned by a JQL query
This operation triggers when a new issue appears in the latest 100 results of a JQL query.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
JQL Query
|
jql | True | string |
Query to use. |
Returns
- Issue
- FullIssue
When a new issue is returned by a JQL query (V2)
This operation triggers when a new issue appears in the latest 100 results of a JQL query.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Jira instance
|
X-Request-Jirainstance | string |
The url where your Jira instance is hosted (must support https). |
|
|
JQL Query
|
jql | True | string |
Query to use. |
Returns
- Issue
- FullIssue
When an issue is closed
This operation triggers when an existing issue is closed in the given project.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Project
|
projectKey | True | string |
Unique key of the project to look for new issues. |
Returns
- Issue
- FullIssue
When an issue is closed (V2)
This operation triggers when an existing issue is closed in the given project.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Jira instance
|
X-Request-Jirainstance | string |
The url where your Jira instance is hosted (must support https). |
|
|
Project
|
projectKey | True | string |
Unique key of the project to look for new issues. |
Returns
- Issue
- FullIssue
Definitions
CreateProjectResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
Project Id
|
id | integer |
Unique id of the project. |
|
Project Key
|
key | string |
Unique key of the project. |
CreateIssueResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
Issue Id
|
id | string |
Unique identifier of the issue. |
|
Issue Key
|
key | string |
Unique key of the issue. |
ListProjects_ResponseV2
| Name | Path | Type | Description |
|---|---|---|---|
|
values
|
values | ProjectArray |
ProjectArray
| Name | Path | Type | Description |
|---|---|---|---|
|
Project Id
|
id | string |
The unique Id of the project. |
|
Project Key
|
key | string |
The unique key of the project. |
|
Project Name
|
name | string |
Name of the project. |
|
Project Type Key
|
projectTypeKey | string |
The unique key of the project type. |
FullIssue
| Name | Path | Type | Description |
|---|---|---|---|
|
Issue Id
|
id | string |
Unique id of the issue. |
|
Issue Key
|
key | string |
Unique key of the issue. |
|
Issue URL
|
self | string |
Browse to the issue using this URL. |
|
Issue Type Id
|
fields.issuetype.id | string |
Unique id of the issue type. |
|
Issue Type Description
|
fields.issuetype.description | string |
Verbose title of the issue type. |
|
Issue Type Icon URL
|
fields.issuetype.iconUrl | string |
Icon associated with the issue type. |
|
Issue Type Name
|
fields.issuetype.name | string |
Title of the issue type. |
|
Time Spent
|
fields.timespent | integer |
The time spent on an issue |
|
Project Id
|
fields.project.id | string |
The unique id of the project. |
|
Project Key
|
fields.project.key | string |
The unique key of the project. |
|
Project Name
|
fields.project.name | string |
Title of the project. |
|
Project Type Key
|
fields.project.projectTypeKey | string |
Unique key of the project type. |
|
Aggregate Time Spent
|
fields.aggregatetimespent | integer |
The aggregate time spent on sub-tasks. |
|
URL of the issue resolution
|
fields.resolution.self | string | |
|
ID of the issue resolution
|
fields.resolution.id | string | |
|
Description of the issue resolution
|
fields.resolution.description | string | |
|
Name fo the issue resolution
|
fields.resolution.name | string | |
|
Resolution Date
|
fields.resolutiondate | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ |
|
Work Ratio
|
fields.workratio | integer |
The percentage of work logged vs the issue estimate. |
|
Created Date
|
fields.created | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ |
|
Priority Icon URL
|
fields.priority.iconUrl | string |
Icon associated with the issue priority. |
|
Priority Name
|
fields.priority.name | string |
Title of the priority. |
|
Priority Id
|
fields.priority.id | string |
Id of the issue priority. |
|
Time Estimate
|
fields.timeestimate | integer |
Time remaining estimated time in seconds. |
|
Aggregate Time Estimate
|
fields.aggregatetimeoriginalestimate | integer |
The original sum of all sub-task time estimates in seconds. |
|
Assignee Id
|
fields.assignee.accountId | string |
Person a issue is assigned to. |
|
Assignee Key
|
fields.assignee.key | string |
User key of the person issue is assigned to. |
|
Assignee Email
|
fields.assignee.emailAddress | string |
Email of the person issue is assigned to. |
|
Assignee Display Name
|
fields.assignee.displayName | string |
Display name of the person issue is assigned to. |
|
Updated Date-Time
|
fields.updated | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ |
|
Status Description
|
fields.status.description | string |
Issue status. |
|
Status Icon URL
|
fields.status.iconUrl | string |
Issue status. |
|
Status Name
|
fields.status.name | string |
Issue status. |
|
Status Id
|
fields.status.id | string |
Issue status. |
|
Status Category Id
|
fields.status.statusCategory.id | integer |
Issue status category. |
|
Status Category Key
|
fields.status.statusCategory.key | string |
Issue status category. |
|
Status Category Color Name
|
fields.status.statusCategory.colorName | string |
Issue status category. |
|
Status Category Name
|
fields.status.statusCategory.name | string |
Issue status category. |
|
Original Time Estimate
|
fields.timeoriginalestimate | integer |
The original time estimate in seconds. |
|
Description
|
fields.description | string |
Issue description. |
|
Aggregate Time Estimate
|
fields.aggregatetimeestimate | integer |
Time sum of all sub-tasks remaining estimated time in seconds. |
|
Summary
|
fields.summary | string |
Title of the issue. |
|
Components
|
fields.components | array of object |
A system field that is multiple values addressed by 'name' (e.g. Microsoft Entra ID, Network Switch). |
|
Component Id
|
fields.components.id | string | |
|
Component Name
|
fields.components.name | string | |
|
Creator Id
|
fields.creator.accountId | string |
User who created the issue. |
|
Creator Key
|
fields.creator.key | string |
Unique key of the user who created the issue. |
|
Creator Email
|
fields.creator.emailAddress | string |
Email of the user who created the issue. |
|
Creator Display Name
|
fields.creator.displayName | string |
Name of the user who created the issue. |
|
Reporter Id
|
fields.reporter.accountId | string |
User who reported the issue. |
|
Reporter Key
|
fields.reporter.key | string |
Unique key of the user who reported the issue. |
|
Reporter Email
|
fields.reporter.emailAddress | string |
Email of the user who reported the issue. |
|
Reporter Display Name
|
fields.reporter.displayName | string |
Display name of the user who reported the issue. |
|
Aggregate Progress Completed
|
fields.aggregateprogress.progress | integer |
The total progress completed of all sub-tasks in seconds. |
|
Aggregate Estimated Effort
|
fields.aggregateprogress.total | integer |
The total sum of all estimated sub-task effort. |
|
Aggregate Progress Percent
|
fields.aggregateprogress.percent | integer |
The percent of aggregate completed progress in relation to estimated effort. |
|
Due Date-Time
|
fields.duedate | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ |
|
Progress Completed
|
fields.progress.progress | integer |
The progress complete in seconds. |
|
Estimated Effort
|
fields.progress.total | integer |
The estimated effort. |
|
Progress Percent
|
fields.progress.percent | integer |
The percent of completed progress in relation to estimated effort. |
|
Epic Name (customfield_10011)
|
fields.customfield_10119 |
Epic name is required for epic issue type. This field matches 'customfield_10011' field on Jira server. |
UserList
| Name | Path | Type | Description |
|---|---|---|---|
|
Id
|
accountId | string |
Id of the project member. |
|
Key
|
key | string |
Unique key associated with the user. |
|
Email
|
emailAddress | string |
Email address of the user. |
|
Display Name
|
displayName | string |
Full name of the user. |
ListFiltersResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
values
|
values | FilterArray |
FilterArray
| Name | Path | Type | Description |
|---|---|---|---|
|
Id
|
id | string |
Id of Filter. |
|
Name
|
name | string |
Name of Filter. |
|
JQL
|
jql | string |
jql used in Filter. |
ListIssuesResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
issues
|
issues | array of FullIssue |
CommentResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
Comment Id
|
id | string |
Unique id of the comment. |
|
Comment Body
|
body | string |
Body of the comment. |
|
Created Date-Time
|
created | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ |
Sites
| Name | Path | Type | Description |
|---|---|---|---|
|
cloud Id
|
id | string | |
|
Site Name
|
name | string | |
|
Site URL
|
url | string |
Transition
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
id | string |
ID of the transition |
|
name
|
name | string |
Name of the transition |
|
to
|
to | TransitionStatus | |
|
fields
|
fields | object |
Fields required for this transition |
TransitionStatus
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
id | string |
ID of the status |
|
name
|
name | string |
Name of the status |