Skip to main content

Jira Component

Manage issues, comments, projects and users in the Jira platform

Component key: atlassian-jira

Changelog ↓

Description​

Jira is a proprietary issue tracking product developed by Atlassian that allows bug tracking and agile project management. This component allows you to create, update, comment on, and delete issues in a Jira project.

API Documentation​

This component was built using the JIRA API Documentation

Connections​

Basic Authentication​

If you select Basic Auth and you are using Jira Cloud, you will need to supply your Jira email and an API token to the connection. If you are on a locally hosted instance of Jira, you will need to supply your Jira email and password to the connection. For information on generating an API token from Jira Cloud, refer to the Atlassian docs.

InputNotesExample
Host

Provide a string value for the URL of your Jira account.

example.atlassian.net
API Key

Provide an api token to authenticate all requests with. Cloud users need to generate an API token for this value.

exampleSecurePassword
Username

Provide a valid username for the given jira account you want to connect.

exampleUser
Version

Select an API version for your Jira API request

3

OAuth 2.0​

While Jira's Cloud API has support for legacy OAuth 1.0, we only offer support for Jira's OAuth 2.0 (3LO) flows. If you select OAuth 2.0, you need to enable it for your app using the Atlassian developer console.

  1. Create a new "Oauth 2.0 integration" and give it a name.
  2. Under the app details section, take note of your client Id and client secret values that were generated.
  3. After you have saved those values, find the Authorization section and click configure on Oauth 2.0 (3LO).
  4. You will now be prompted to enter your redirect URL as https://oauth2.prismatic.io/callback.
  5. Next, navigate to the permissions. It is important that you remain consistent with the scopes you supply in both Jira, and your connection.
  6. The default scopes on a new connection will be as follows:
    1. read:project:jira read:user:jira write:issue:jira read:issue:jira read:issue-link:jira write:issue-link:jira read:issue-link-type:jira write:issue-link-type:jira read:issue.transition:jira delete:issue:jira
    2. These scopes will provide access to the most of the actions in the Jira component, but you may have to modify the scopes in both locations (here and Atlassian Console) to meet your needs.
  7. For more information on developing Jira applications, follow the guide here.
  8. Next, configure an OAuth 2.0 connection.
  9. Add a Jira step to your integration.
    1. This will automatically create a Jira connection config variable.
  10. Ensure the connection is of type Jira OAuth 2.0 Connection and enter the following details:
  11. For Client ID and Client Secret enter the values that you got from the Atlassian Developer Console
  12. As stated previously Scopes will default to the following:
    1. read:project:jira read:user:jira write:issue:jira read:issue:jira read:issue-link:jira write:issue-link:jira read:issue-link-type:jira write:issue-link-type:jira read:issue.transition:jira delete:issue:jira.
  13. With the addition of offline_access on the connection side to obtain a refresh token. From here you can do any additional configuration to match your use case. For example, you might assign the scopes manage:jira-project read:jira-user if you plan to work with Users and Projects. You will need to enable these scopes on the Atlassian Developer Console page for your OAuth 2.0 Jira app. It is important to include offline_access in your scopes, or you will not be given a refresh token.
  14. For Version enter the version of Jira you use (you likely use version 2).
    1. Jira API: manage:jira-configuration, manage:jira-project, write:jira-work, read:jira-work.
InputNotesExample
Jira Site Name

By default this connector connects to the first Jira site this user has access to. If you have multiple Jira sites, please specify which one you would like to connect to, you can use the site name or the full url.

example or example.atlassian.net
Authorize URL

The OAuth 2.0 Authorization URL for Jira

https://auth.atlassian.com/authorize?audience=api.atlassian.com&prompt=consent
Client IDc9e4APadFFkbtTycoNtrHKBtYgUyZWy
Client SecretntDBx4ao5czkFu7Mzp5FTlYG0y3_ukxkSiPhwnTkhsdKHJITGRCGP3ZWlXTYyu
Scopes

A space-delimited set of one or more scopes to get the user's permission to access. For more information on scopes, see Jira V3 Scopes.

read:jira-user read:jira-work write:jira-work manage:jira-project manage:jira-configuration manage:jira-webhook offline_access
Token URL

The OAuth 2.0 Token URL for Jira

https://auth.atlassian.com/oauth/token
Version

Select an API version for your Jira API request

3

Data Sources​

Issue Fields​

A map of a list of fields to Jira Issue Fields. | key: issueFields | type: picklist

InputNotesExample
Connection
Only Custom Fieldsfalse

Select Board​

Select a board | key: selectBoard | type: picklist

InputNotesExample
Filter

The filter applied to the list of dashboards.

my
Connection
Max Results

Provide a value for the maximum amount of results to be returned in the request.

50
Start At

Provide the index of the first item to return (to start from)

3

Select Board Version​

Select a board version | key: selectBoardVersion | type: picklist

InputNotesExample
Board ID

Provide the ID of the Board.

10201
Connection
Max Results

Provide a value for the maximum amount of results to be returned in the request.

50
Start At

Provide the index of the first item to return (to start from)

3

Select Issue by Project​

Select an issue from the specified project. | key: selectIssue | type: picklist

InputNotesExample
Connection
Project ID

Provide the ID or Name of the Project.

10201

Select Issue Type from Project​

Select an issue type from the specified project. | key: selectIssueTypeFromProject | type: picklist

InputNotesExample
Connection
Project ID

Provide the ID or Name of the Project.

10201
Issue Type Return

Select whether to return the Issue Type ID or Name. Use false to return the ID and true to return the Name.

false

Select Issue Type from Projects​

Select an issue type from the specified projects. | key: selectIssueType | type: picklist

InputNotesExample
Connection
Project ID(s)

Provide one or more Project IDs.

10201
Issue Type Return

Select whether to return the Issue Type ID or Name. Use false to return the ID and true to return the Name.

false

Select Issue Types from Projects​

Select one or many Issue Types from the specified projects. | key: selectIssueTypes | type: objectSelection

InputNotesExample
Connection
Project ID(s)

Provide one or more Project IDs.

10201

Select Priority​

Select a priority | key: selectPriority | type: picklist

InputNotesExample
Connection

Select Project​

Select a project | key: selectProject | type: picklist

InputNotesExample
Connection

Select Projects​

Select one or many projects | key: selectProjects | type: objectSelection

InputNotesExample
Connection

Select Webhook​

Select a webhook | key: selectWebhook | type: picklist

InputNotesExample
Connection

Actions​

Add Comment​

Add a comment to an existing issue | key: addComment

InputNotesExample
Comment

Provide a string value for the comment.

This is an example comment.
Dynamic Fields

A field for dynamic inputs that can be configured at deploy time with the use of a key value config variable.

Values

The names of the fields and their values to use when creating/updating a record

projectId=1000,name=Example
Issue ID

Provide the ID of the Issue.

10201
Connection

{
  "data": {
    "self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10001",
    "id": "10001",
    "author": {
      "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
      "accountId": "5b10a2844c20165700ede21g",
      "displayName": "Jane Doe",
      "active": true
    },
    "body": {
      "type": "doc",
      "version": 1,
      "content": [
        {
          "type": "paragraph",
          "content": [
            {
              "type": "text",
              "text": "This is a new comment added to the issue."
            }
          ]
        }
      ]
    },
    "updateAuthor": {
      "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
      "accountId": "5b10a2844c20165700ede21g",
      "displayName": "Jane Doe",
      "active": true
    },
    "created": "2021-01-17T12:34:00.000+0000",
    "updated": "2021-01-17T12:34:00.000+0000"
  }
}

Add Issue Attachment​

Add a file attachment to an issue | key: addIssueAttachment

InputNotesExample
File

The file to upload - either string contents or a binary file

File Name

The name of the file to upload

Issue ID

Provide the ID of the Issue.

10201
Connection

Create Issue​

Create an issue within a given project | key: createIssue

InputNotesExample
ADF Description

The above json code will print: 'Some text' in the Jira Issue description, to get more info visit: https://developer.atlassian.com/cloud/jira/platform/apis/document/playground/ to get a JSON representation of your description.

Assignee Account ID

Provide the Account ID for the person being assigned the issue.

b7b399c5b7c40279d7211271
Description

Provide a string value for the description of the issue.

This is an example summary.
Due Date

Provide due date for the issue.

2019-05-11
Dynamic Fields

A field for dynamic inputs that can be configured at deploy time with the use of a key value config variable.

Values

The names of the fields and their values to use when creating/updating a record

projectId=1000,name=Example
Fix Versions

Provide JSON data for the fix versions. Your object must have a property 'id'

Issue Type Name

Provide a value for the name type of the issue. Use this field or the Issue Type ID field.

Task
Issue Type ID

Provide the ID of the Issue Type. Use this field or the Issue Type Name field.

10001
Connection
Labels

Provide a list of labels for the issue.

performance
Priority

Provide the unique identifier of the priority. This value can either be an Id, key, or name of the desired record.

High
Project ID

Provide the ID or Name of the Project.

10201
Reporter Account ID

Provide the Account ID for the person that is reporting the issue.

b7b399c5b7c40279d7211271
Summary

Provide a string value for the summary of the issue.

This is an example summary.
Versions

Provide JSON data for the versions. You must supply a JSON array with an object containing an Id.

{
  "data": {
    "id": "10001",
    "key": "HSP-25",
    "self": "https://your-domain.atlassian.net/rest/api/3/issue/10001"
  }
}

Create User​

Create a new user record | key: createUser

InputNotesExample
Display Name

Provide a string value for the display name to assign to the new user.

John Doe
Dynamic Fields

A field for dynamic inputs that can be configured at deploy time with the use of a key value config variable.

Email Address

Provide a string value for a valid email address.

someone@example.com
Values

The names of the fields and their values to use when creating/updating a record

projectId=1000,name=Example
Connection
Notifications

This flag will determine if the user will receive notifications.

false
Password

Provide a password to assign to the user.

superSecretPassword
Username

Provide a string value for the username of the user.

Example User

Create Version​

Create a new version | key: createVersion

InputNotesExample
Archived

This flag determines if the given version is archived.

false
Description

Provide a string value for the description of the issue.

This is an example summary.
Dynamic Fields

A field for dynamic inputs that can be configured at deploy time with the use of a key value config variable.

Values

The names of the fields and their values to use when creating/updating a record

projectId=1000,name=Example
Connection
Project ID

Provide the ID or Name of the Project.

10201
Project Key

Provide a string value for the key of the project.

JS-Example
Released

This flag determines if the given version has been released.

false
Release Date

Provide a valid date for the release of the given version.

2021-07-22
Start Date

Provide a value for the startDate.

2021-07-22
Version Name

Provide a string value for the name of the version.

2019.08.18

{
  "data": {
    "self": "https://your-domain.atlassian.net/rest/api/3/version/10000",
    "id": "10000",
    "description": "An excellent version",
    "name": "New Version 1",
    "archived": false,
    "released": true,
    "releaseDate": "2010-07-06",
    "userReleaseDate": "6/Jul/2010",
    "project": "PXA",
    "projectId": 10000
  }
}

Create Webhook​

Create a webhook to send data from Jira to an instance URL | key: createWebhook

InputNotesExample
Connection
Webhook Details

Webhook Details payload to be sent into Jira's OAuth2 Webhook API or Jira's REST API; must match structure of webhooks property for Register Dynamic Webhook endpoint: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-webhooks/#api-rest-api-3-webhook-post

Webhook URL

Reference a flow's URL from the trigger payload

Registering a Dynamic Webhook requires supplying a highly configurable payload called "Webhook Details". It's important to configure this for all use cases as each Jira app is only permitted to create and manage one endpoint.

Registering a Webhook Notes

Please note that whenever trying to register a webhook, the request payload's structure is different depending on the authentication method:

{
  "name": "my first webhook via rest",
  "description": "description of my first webhook",
  "events": ["jira:issue_created", "jira:issue_updated"],
  "filters": {
    "issue-related-events-section": "Project = JRA AND resolution = Fixed"
  },
  "excludeBody": false,
  "secret": "G8j4166a5OkXRD4WbqV3"
}
[
  {
    "events": ["jira:issue_created", "jira:issue_updated"],
    "fieldIdsFilter": ["summary", "customfield_10029"],
    "jqlFilter": "project = PROJ"
  },
  {
    "events": ["jira:issue_deleted"],
    "jqlFilter": "project IN (PROJ, EXP) AND status = done"
  },
  {
    "events": ["issue_property_set"],
    "issuePropertyKeysFilter": ["my-issue-property-key"],
    "jqlFilter": "project = PROJ"
  }
]

{
  "data": {
    "webhookRegistrationResult": [
      {
        "createdWebhookId": 7
      }
    ]
  }
}

Delete Comment​

Delete a comment from an issue | key: deleteComment

InputNotesExample
Comment ID

Provide the Comment ID.

10201
Issue ID

Provide the ID of the Issue.

10201
Connection

Delete Issue​

Delete an issue by id | key: deleteIssue

InputNotesExample
Issue ID

Provide the ID of the Issue.

10201
Connection

Delete Webhook​

Delete a webhook by ID | key: deleteWebhook

InputNotesExample
Connection
Webhook ID

The ID of the webhook to remove

{
  "data": null
}

Download Issue Attachments​

Download the attachments data connected to an issue | key: downloadAttachment

InputNotesExample
Attachment IDs

The IDs of the attachments to download. If this field is provided, the issue id input will be ignored.

Issue ID

Providing an Issue ID will return all attachments of an Issue.

10201
Connection

Find Issue​

Find Issue by attribute | key: findIssue

InputNotesExample
Fields

Comma-separated list of fields to return. Defaults to common navigable fields (summary, status, assignee, reporter, priority, issuetype, project, created, updated). Use '*all' for all fields or specify individual field names.

summary,status,assignee,priority
Connection
Search Type

Attribute to search

Search Value

Value to search for

Find Project​

Find Project by attribute | key: findProject

InputNotesExample
Connection
Search Type

Attribute to search

Search Value

Value to search for

Find User​

Find User by attribute | key: findUser

InputNotesExample
Connection
Search Value

Value to search for

Get Board​

Get information and metadata of a board by Id | key: getBoard

InputNotesExample
Board ID

Provide the ID of the Board.

10201
Connection

{
  "data": {
    "id": 84,
    "self": "https://your-domain.atlassian.net/rest/agile/1.0/board/84",
    "name": "scrum board",
    "type": "scrum",
    "location": {
      "projectId": 10040,
      "userId": 10040,
      "userAccountId": "5b10a2844c20165700ede21g",
      "displayName": "Example Project",
      "projectName": "Example Project",
      "projectKey": "Example Project Key",
      "projectTypeKey": "KEY",
      "name": "Example Project"
    }
  }
}

Get Comments​

Get all the comments on a given issue | key: getComments

InputNotesExample
Issue ID

Provide the ID of the Issue.

10201
Connection

{
  "data": {
    "data": {
      "startAt": 0,
      "maxResults": 1,
      "total": 1,
      "comments": [
        {
          "self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000",
          "id": "10000",
          "author": {
            "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
            "accountId": "5b10a2844c20165700ede21g",
            "displayName": "Mia Krystof",
            "active": false
          },
          "body": {
            "type": "doc",
            "version": 1,
            "content": [
              {
                "type": "paragraph",
                "content": [
                  {
                    "type": "text",
                    "text": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue semper."
                  }
                ]
              }
            ]
          },
          "updateAuthor": {
            "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
            "accountId": "5b10a2844c20165700ede21g",
            "displayName": "Mia Krystof",
            "active": false
          },
          "created": "2021-01-17T12:34:00.000+0000",
          "updated": "2021-01-18T23:45:00.000+0000",
          "visibility": {
            "type": "role",
            "value": "Administrators",
            "identifier": "Administrators"
          }
        }
      ]
    }
  }
}

Get Current User​

Get the information and metadata of the current user | key: getCurrentUser

InputNotesExample
Connection

Get Issue​

Get the information and metadata of an issue | key: getIssue

InputNotesExample
Issue ID

Provide the ID of the Issue.

10201
Connection

{
  "data": {
    "fields": {
      "watcher": {
        "isWatching": true,
        "self": "https://your-domain.atlassian.net/rest/api/2/issue/PROJ-123/watchers",
        "watchCount": 5
      },
      "attachment": [
        {
          "author": {
            "accountId": "5b10ac8d82e05b22cc7d4ef5",
            "accountType": "atlassian",
            "active": true,
            "avatarUrls": {
              "16x16": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10ac8d82e05b22cc7d4ef5/16x16.png",
              "24x24": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10ac8d82e05b22cc7d4ef5/24x24.png",
              "32x32": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10ac8d82e05b22cc7d4ef5/32x32.png",
              "48x48": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10ac8d82e05b22cc7d4ef5/48x48.png"
            },
            "displayName": "John Doe",
            "key": "jdoe",
            "name": "jdoe",
            "self": "https://your-domain.atlassian.net/rest/api/2/user?accountId=5b10ac8d82e05b22cc7d4ef5"
          },
          "content": "https://your-domain.atlassian.net/secure/attachment/12345/document.pdf",
          "created": "2023-08-29T10:30:00.000+0000",
          "filename": "document.pdf",
          "id": 12345,
          "mimeType": "application/pdf",
          "self": "https://your-domain.atlassian.net/rest/api/2/attachment/12345",
          "size": 1024000,
          "thumbnail": "https://your-domain.atlassian.net/secure/thumbnail/12345"
        }
      ],
      "sub-tasks": [
        {
          "id": "10001",
          "outwardIssue": {
            "fields": {
              "status": {
                "iconUrl": "https://your-domain.atlassian.net/images/icons/statuses/open.png",
                "name": "Open"
              }
            },
            "id": "10002",
            "key": "PROJ-124",
            "self": "https://your-domain.atlassian.net/rest/api/2/issue/10002"
          },
          "type": {
            "id": "10003",
            "inward": "subtask of",
            "name": "Subtask",
            "outward": "parent task of"
          }
        }
      ],
      "description": {
        "type": "doc",
        "version": 1,
        "content": [
          {
            "type": "paragraph",
            "content": [
              {
                "type": "text",
                "text": "This is a sample issue description."
              }
            ]
          }
        ]
      },
      "project": {
        "avatarUrls": {
          "16x16": "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
          "24x24": "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
          "32x32": "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000",
          "48x48": "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000"
        },
        "id": "10000",
        "insight": {
          "lastIssueUpdateTime": "2023-08-29T14:30:00.000+0000",
          "totalIssueCount": 150
        },
        "key": "PROJ",
        "name": "Sample Project",
        "projectCategory": {
          "description": "Projects for development team",
          "id": "10001",
          "name": "Development",
          "self": "https://your-domain.atlassian.net/rest/api/2/projectCategory/10001"
        },
        "self": "https://your-domain.atlassian.net/rest/api/2/project/10000",
        "simplified": false,
        "style": "classic"
      },
      "comment": [
        {
          "author": {
            "accountId": "5b10ac8d82e05b22cc7d4ef5",
            "active": true,
            "displayName": "John Doe",
            "self": "https://your-domain.atlassian.net/rest/api/2/user?accountId=5b10ac8d82e05b22cc7d4ef5"
          },
          "body": {
            "type": "doc",
            "version": 1,
            "content": [
              {
                "type": "paragraph",
                "content": [
                  {
                    "type": "text",
                    "text": "This is a comment on the issue."
                  }
                ]
              }
            ]
          },
          "created": "2023-08-29T11:00:00.000+0000",
          "id": "10050",
          "self": "https://your-domain.atlassian.net/rest/api/2/issue/PROJ-123/comment/10050",
          "updateAuthor": {
            "accountId": "5b10ac8d82e05b22cc7d4ef5",
            "active": true,
            "displayName": "John Doe",
            "self": "https://your-domain.atlassian.net/rest/api/2/user?accountId=5b10ac8d82e05b22cc7d4ef5"
          },
          "updated": "2023-08-29T11:00:00.000+0000",
          "visibility": {
            "identifier": "developers",
            "type": "group",
            "value": "developers"
          }
        }
      ],
      "issuelinks": [
        {
          "id": "10060",
          "inwardIssue": {
            "fields": {
              "status": {
                "iconUrl": "https://your-domain.atlassian.net/images/icons/statuses/inprogress.png",
                "name": "In Progress"
              }
            },
            "id": "10070",
            "key": "PROJ-125",
            "self": "https://your-domain.atlassian.net/rest/api/2/issue/10070"
          },
          "type": {
            "id": "10000",
            "inward": "is blocked by",
            "name": "Blocks",
            "outward": "blocks"
          }
        }
      ],
      "worklog": [
        {
          "author": {
            "accountId": "5b10ac8d82e05b22cc7d4ef5",
            "active": true,
            "displayName": "John Doe",
            "self": "https://your-domain.atlassian.net/rest/api/2/user?accountId=5b10ac8d82e05b22cc7d4ef5"
          },
          "comment": {
            "type": "doc",
            "version": 1,
            "content": [
              {
                "type": "paragraph",
                "content": [
                  {
                    "type": "text",
                    "text": "Worked on implementing the feature."
                  }
                ]
              }
            ]
          },
          "id": "10080",
          "issueId": "10000",
          "self": "https://your-domain.atlassian.net/rest/api/2/issue/PROJ-123/worklog/10080",
          "started": "2023-08-29T09:00:00.000+0000",
          "timeSpent": "2h",
          "timeSpentSeconds": 7200,
          "updateAuthor": {
            "accountId": "5b10ac8d82e05b22cc7d4ef5",
            "active": true,
            "displayName": "John Doe",
            "self": "https://your-domain.atlassian.net/rest/api/2/user?accountId=5b10ac8d82e05b22cc7d4ef5"
          },
          "updated": "2023-08-29T09:00:00.000+0000",
          "visibility": {
            "identifier": "developers",
            "type": "group",
            "value": "developers"
          }
        }
      ],
      "updated": 1693312200000,
      "timetracking": {
        "originalEstimate": "1w 2d",
        "originalEstimateSeconds": 777600,
        "remainingEstimate": "5d",
        "remainingEstimateSeconds": 432000,
        "timeSpent": "2d",
        "timeSpentSeconds": 172800
      }
    },
    "id": "10000",
    "key": "PROJ-123",
    "self": "https://your-domain.atlassian.net/rest/api/2/issue/10000"
  }
}

Get Project​

Get the information and metadata of a project | key: getProject

InputNotesExample
Connection
Project ID

Provide the ID or Name of the Project.

10201

{
  "data": {
    "expand": "description,lead,url,projectKeys",
    "self": "https://your-domain.atlassian.net/rest/api/3/project/EX",
    "id": "10000",
    "key": "EX",
    "name": "Example Project",
    "projectTypeKey": "software",
    "simplified": false,
    "style": "next-gen",
    "isPrivate": false,
    "lead": {
      "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
      "accountId": "5b10a2844c20165700ede21g",
      "displayName": "John Smith",
      "active": true
    },
    "components": [],
    "versions": [],
    "roles": {
      "Developers": "https://your-domain.atlassian.net/rest/api/3/project/EX/role/10001",
      "Users": "https://your-domain.atlassian.net/rest/api/3/project/EX/role/10002"
    }
  }
}

Get Status List​

Returns a status list | key: getStatusList

InputNotesExample
Connection
Max Results

Provide a value for the maximum amount of results to be returned in the request.

50
Project ID

Provide the ID or Name of the Project.

10201
Start At

Provide the index of the first item to return (to start from)

3

Get User​

Get information and metadata about an user by id | key: getUser

InputNotesExample
Account ID

Provide the Account ID of the account to use.

b7b399c5b7c40279d7211271
Expand

The response may contain a list under the _expandable property; you can specify any of its values separated by commas.

body, version, history
Connection

Get Version​

Get the information and metadata of an existing version | key: getVersion

InputNotesExample
Connection
Version ID

Provide the ID of the Version.

10201

List Assignable Users for Project​

Returns a list of users assignable to the given project | key: listAssignableUsers

InputNotesExample
Connection
Max Results

Provide a value for the maximum amount of results to be returned in the request.

50
Project Key

Provide a string value for the key of the project.

JS-Example
Start At

Provide the index of the first item to return (to start from)

3

{
  "data": [
    {
      "displayName": "exampleUser",
      "accountId": "example-483204",
      "accountType": "atlassian",
      "emailAddress": "someone@example.com",
      "active": true
    },
    {
      "displayName": "exampleUser",
      "accountId": "example-483204",
      "accountType": "atlassian",
      "emailAddress": "someone@example.com",
      "active": true
    }
  ]
}

List Board Sprints​

List all sprints within a board | key: listBoardsSprints

InputNotesExample
Board ID

Provide the ID of the Board.

10201
Connection
Max Results

Provide a value for the maximum amount of results to be returned in the request.

50
Start At

Provide the index of the first item to return (to start from)

3

{
  "data": {
    "maxResults": 2,
    "startAt": 1,
    "total": 5,
    "isLast": false,
    "values": [
      {
        "id": 37,
        "self": "https://your-domain.atlassian.net/rest/agile/1.0/sprint/23",
        "state": "closed",
        "name": "sprint 1",
        "startDate": "2015-04-11T15:22:00.000+10:00",
        "endDate": "2015-04-20T01:22:00.000+10:00",
        "completeDate": "2015-04-20T11:04:00.000+10:00",
        "originBoardId": 5,
        "goal": "sprint 1 goal"
      },
      {
        "id": 72,
        "self": "https://your-domain.atlassian.net/rest/agile/1.0/sprint/73",
        "state": "future",
        "name": "sprint 2",
        "goal": "sprint 2 goal"
      }
    ]
  }
}

List Boards​

Retrieve a list of existing boards | key: listBoards

InputNotesExample
Filter

The filter applied to the list of dashboards.

my
Connection
Max Results

Provide a value for the maximum amount of results to be returned in the request.

50
Start At

Provide the index of the first item to return (to start from)

3

{
  "data": {
    "maxResults": 2,
    "startAt": 1,
    "total": 5,
    "isLast": false,
    "values": [
      {
        "id": 84,
        "self": "https://your-domain.atlassian.net/rest/agile/1.0/board/84",
        "name": "scrum board",
        "type": "scrum"
      },
      {
        "id": 92,
        "self": "https://your-domain.atlassian.net/rest/agile/1.0/board/92",
        "name": "kanban board",
        "type": "kanban"
      }
    ]
  }
}

List Issue Attachments​

Returns a list of issue attachments | key: listIssueAttachments

InputNotesExample
Issue ID

Provide the ID of the Issue.

10201
Connection

List Issue Custom Fields​

List all configured issue fields | key: listIssueCustomFields

InputNotesExample
Connection

{
  "data": [
    {
      "clauseNames": [],
      "custom": true,
      "id": "statuscategorychangedate",
      "key": "statuscategorychangedate",
      "name": "Status Category Changed",
      "navigable": true,
      "orderable": false,
      "schema": {
        "type": "datetime",
        "system": "statuscategorychangedate"
      },
      "searchable": true
    }
  ]
}

List Issue Fields​

List all non-custom issue fields | key: listIssueFields

InputNotesExample
Connection

{
  "data": [
    {
      "id": "description",
      "name": "Description",
      "custom": false,
      "orderable": true,
      "navigable": true,
      "searchable": true,
      "clauseNames": [
        "description"
      ],
      "schema": {
        "type": "string",
        "system": "description"
      }
    },
    {
      "id": "summary",
      "key": "summary",
      "name": "Summary",
      "custom": false,
      "orderable": true,
      "navigable": true,
      "searchable": true,
      "clauseNames": [
        "summary"
      ],
      "schema": {
        "type": "string",
        "system": "summary"
      }
    }
  ]
}

List all available issue link types | key: listIssueLinkTypes

InputNotesExample
Connection

List Issue Transitions​

Returns a list of issue transitions | key: listIssueTransitions

InputNotesExample
Issue ID

Provide the ID of the Issue.

10201
Connection

{
  "data": {
    "expand": "transitions",
    "transitions": [
      {
        "id": "21",
        "name": "In Progress",
        "to": {
          "self": "https://your-domain.atlassian.net/rest/api/3/status/3",
          "description": "This issue is being actively worked on at the moment by the assignee.",
          "iconUrl": "https://your-domain.atlassian.net/images/icons/statuses/inprogress.png",
          "name": "In Progress",
          "id": "3"
        },
        "hasScreen": false,
        "isGlobal": true,
        "isInitial": false,
        "isConditional": false
      },
      {
        "id": "31",
        "name": "Done",
        "to": {
          "self": "https://your-domain.atlassian.net/rest/api/3/status/10001",
          "description": "Work has been completed on this issue.",
          "name": "Done",
          "id": "10001"
        },
        "hasScreen": false,
        "isGlobal": true,
        "isInitial": false,
        "isConditional": false
      }
    ]
  }
}

List Issue Types​

Returns a list of issue types | key: listIssueTypes

InputNotesExample
Connection

List Issue Worklogs​

Returns a list of issue worklogs | key: listIssueWorklogs

InputNotesExample
Issue ID

Provide the ID of the Issue.

10201
Connection

List Issues by Project​

Returns a list of issues for a specific project | key: listIssues

InputNotesExample
Fields

Comma-separated list of fields to return. Defaults to common navigable fields (summary, status, assignee, reporter, priority, issuetype, project, created, updated). Use '*all' for all fields or specify individual field names.

summary,status,assignee,priority
Connection
Max Results

Provide a value for the maximum amount of results to be returned in the request.

50
Next Page Token

Token for cursor-based pagination. Use the token returned from the previous response to get the next page of results. Leave empty for the first page.

Project ID

Provide the ID or Name of the Project.

10201

{
  "data": {
    "expand": "names,schema",
    "startAt": 0,
    "maxResults": 50,
    "total": 3,
    "issues": [
      {
        "id": "10001",
        "key": "HSP-1",
        "fields": {
          "summary": "Bug in authorization process",
          "status": {
            "name": "Open"
          },
          "priority": {
            "name": "Medium"
          }
        }
      },
      {
        "id": "10002",
        "key": "HSP-2",
        "fields": {
          "summary": "Feature request for dashboard",
          "status": {
            "name": "In Progress"
          },
          "priority": {
            "name": "High"
          }
        }
      },
      {
        "id": "10003",
        "key": "HSP-3",
        "fields": {
          "summary": "Documentation update needed",
          "status": {
            "name": "To Do"
          },
          "priority": {
            "name": "Low"
          }
        }
      }
    ]
  }
}

List Priorities​

Returns a list of all priorities | key: listPriorities

InputNotesExample
Connection
Max Results

Provide a value for the maximum amount of results to be returned in the request.

50
Start At

Provide the index of the first item to return (to start from)

3

List Projects​

Retrieve a list of all projects | key: listProjects

InputNotesExample
Connection
Max Results

Provide a value for the maximum amount of results to be returned in the request.

50
Start At

Provide the index of the first item to return (to start from)

3

{
  "data": {
    "self": "https://your-domain.atlassian.net/rest/api/3/project/search",
    "nextPage": "https://your-domain.atlassian.net/rest/api/3/project/search?startAt=2",
    "maxResults": 2,
    "startAt": 0,
    "total": 7,
    "isLast": false,
    "values": [
      {
        "expand": "description,lead,url,projectKeys",
        "self": "https://your-domain.atlassian.net/rest/api/3/project/EX",
        "id": "10000",
        "key": "EX",
        "name": "Example Project",
        "projectTypeKey": "software",
        "simplified": false,
        "style": "next-gen"
      },
      {
        "expand": "description,lead,url,projectKeys",
        "self": "https://your-domain.atlassian.net/rest/api/3/project/ABC",
        "id": "10001",
        "key": "ABC",
        "name": "Another Project",
        "projectTypeKey": "business",
        "simplified": true,
        "style": "classic"
      }
    ]
  }
}

List Versions​

Returns a list of all versions | key: listVersions

InputNotesExample
Connection
Max Results

Provide a value for the maximum amount of results to be returned in the request.

50
Project ID

Provide the ID or Name of the Project.

10201
Start At

Provide the index of the first item to return (to start from)

3

{
  "data": {
    "self": "https://your-domain.atlassian.net/rest/api/3/project/PR/version?startAt=0&maxResults=2",
    "nextPage": "https://your-domain.atlassian.net/rest/api/3/project/PR/version?startAt=2&maxResults=2",
    "maxResults": 2,
    "startAt": 0,
    "total": 7,
    "isLast": false,
    "values": [
      {
        "self": "https://your-domain.atlassian.net/rest/api/3/version/10000",
        "id": "10000",
        "description": "An excellent version",
        "name": "New Version 1",
        "archived": false,
        "released": true,
        "releaseDate": "2010-07-06",
        "overdue": true,
        "userReleaseDate": "6/Jul/2010",
        "projectId": 10000
      },
      {
        "self": "https://your-domain.atlassian.net/rest/api/3/version/10010",
        "id": "10010",
        "description": "Minor Bugfix version",
        "name": "Next Version",
        "archived": false,
        "released": false,
        "overdue": false,
        "projectId": 10000,
        "issuesStatusForFixVersion": {
          "unmapped": 0,
          "toDo": 10,
          "inProgress": 20,
          "done": 100
        }
      }
    ]
  }
}

List Webhooks​

List all webhooks configured, including those for other integrations | key: listWebhooks

InputNotesExample
Fetch All

Turn on to fetch more than the default limit of results

false
Connection

{
  "data": {
    "isLast": true,
    "maxResults": 100,
    "startAt": 0,
    "total": 1,
    "values": [
      {
        "events": [
          "jira:issue_created"
        ],
        "expirationDate": "2022-12-18T15:22:13.418-0900",
        "id": 1,
        "jqlFilter": "project = EXAMPLE"
      }
    ]
  }
}

Query​

Search your entire Jira site using a JQL query. | key: queryV3

InputNotesExample
Expand

The response may contain a list under the _expandable property; you can specify any of its values separated by commas.

body, version, history
Connection
Max Results

Provide a value for the maximum amount of results to be returned in the request.

50
Search

Provide a string value to search on.

status IN ("To Do", "In Progress", "Closed")

Raw Request​

Send raw HTTP request to Jira | key: rawRequest

InputNotesExample
Connection
Data

The HTTP body payload to send to the URL.

{"exampleKey": "Example Data"}
File Data

File Data to be sent as a multipart form upload.

[{key: "example.txt", value: "My File Contents"}]
File Data File Names

File names to apply to the file data inputs. Keys must match the file data keys above.

Form Data

The Form Data to be sent as a multipart form upload.

[{"key": "Example Key", "value": new Buffer("Hello World")}]
Header

A list of headers to send with the request.

User-Agent: curl/7.64.1
Max Retry Count

The maximum number of retries to attempt. Specify 0 for no retries.

0
Method

The HTTP method to use.

Query Parameter

A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.

Response Type

The type of data you expect in the response. You can request json, text, or binary data.

json
Retry On All Errors

If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors.

false
Retry Delay (ms)

The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.

0
Timeout

The maximum time that a client will await a response to its request

2000
URL

Input the path only (/rest/api/3/project/recent), The base URL is already included (https://api.atlassian.com/ex/jira/<CLOUD_ID>). For example, to connect to https://api.atlassian.com/ex/jira/<CLOUD_ID>/rest/api/3/project/recent, only /rest/api/3/project/recent is entered in this field.

/sobjects/Account
Use Exponential Backoff

Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.

false

Refresh Webhook​

Refresh webhook expiration by ID | key: refreshWebhook

InputNotesExample
Connection
Webhook ID

ID of the webhook to refresh

{
  "data": {
    "expirationDate": "2022-12-21T09:20:20.388-0900"
  }
}

Search Issues​

Returns a list of issues that match the given string of text | key: searchIssues

InputNotesExample
Fields

Comma-separated list of fields to return. Defaults to common navigable fields (summary, status, assignee, reporter, priority, issuetype, project, created, updated). Use '*all' for all fields or specify individual field names.

summary,status,assignee,priority
Connection
Project Key

Provide a string value for the key of the project.

JS-Example
Search

Provide a string value to search on.

Search

{
  "data": {
    "expand": "names,schema",
    "startAt": 0,
    "maxResults": 50,
    "total": 1,
    "issues": [
      {
        "expand": "",
        "id": "10001",
        "self": "https://your-domain.atlassian.net/rest/api/3/issue/10001",
        "key": "HSP-1",
        "fields": {
          "summary": "Bug in authorization process",
          "issueType": {
            "name": "Bug",
            "id": "1"
          },
          "project": {
            "key": "HSP",
            "name": "Example Project",
            "id": "10000"
          },
          "status": {
            "name": "Open",
            "id": "1"
          },
          "priority": {
            "name": "Medium",
            "id": "3"
          },
          "assignee": {
            "displayName": "John Smith",
            "accountId": "5b10a2844c20165700ede21g"
          }
        }
      }
    ]
  }
}

Search Projects​

Returns a list of projects that match the given string of text | key: searchProjects

InputNotesExample
Connection
Search

Provide a string value to search on.

Search

Search Users​

Returns a single user that matches the given string of text | key: searchUsers

InputNotesExample
Connection
Search

Provide a string value to search on.

Search

Transition Issue​

Transition an existing issue by Id | key: transitionIssue

InputNotesExample
Issue ID

Provide the ID of the Issue.

10201
Connection
Transition ID

Provide the ID of the Transition.

10201

Update Comment​

Update the contents and metadata of an existing comment. | key: updateComment

InputNotesExample
Comment

Provide a string value for the comment.

This is an example comment.
Comment ID

Provide the Comment ID.

10201
Dynamic Fields

A field for dynamic inputs that can be configured at deploy time with the use of a key value config variable.

Values

The names of the fields and their values to use when creating/updating a record

projectId=1000,name=Example
Issue ID

Provide the ID of the Issue.

10201
Connection

{
  "data": {
    "self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10001",
    "id": "10001",
    "author": {
      "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
      "accountId": "5b10a2844c20165700ede21g",
      "displayName": "Jane Doe",
      "active": true
    },
    "body": {
      "type": "doc",
      "version": 1,
      "content": [
        {
          "type": "paragraph",
          "content": [
            {
              "type": "text",
              "text": "This is an updated comment."
            }
          ]
        }
      ]
    },
    "updateAuthor": {
      "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
      "accountId": "5b10a2844c20165700ede21g",
      "displayName": "Jane Doe",
      "active": true
    },
    "created": "2021-01-17T12:34:00.000+0000",
    "updated": "2021-01-18T10:15:00.000+0000"
  }
}

Update Issue​

Update an existing issue within a given project | key: updateIssue

InputNotesExample
ADF Description

The above json code will print: 'Some text' in the Jira Issue description, to get more info visit: https://developer.atlassian.com/cloud/jira/platform/apis/document/playground/ to get a JSON representation of your description.

Assignee Account ID

Provide the Account ID for the person being assigned the issue.

b7b399c5b7c40279d7211271
Description

Provide a string value for the description of the issue.

This is an example summary.
Due Date

Provide due date for the issue.

2019-05-11
Dynamic Fields

A field for dynamic inputs that can be configured at deploy time with the use of a key value config variable.

Values

The names of the fields and their values to use when creating/updating a record

projectId=1000,name=Example
Fix Versions

Provide JSON data for the fix versions. Your object must have a property 'id'

Issue ID

Provide the ID of the Issue.

10201
Issue Type Name

Provide a value for the name type of the issue. Use this field or the Issue Type ID field.

Task
Issue Type ID

Provide the ID of the Issue Type. Use this field or the Issue Type Name field.

10001
Connection
Labels

Provide a list of labels for the issue.

performance
Priority

Provide the unique identifier of the priority. This value can either be an Id, key, or name of the desired record.

High
Project ID

Provide the ID or Name of the Project.

10201
Reporter Account ID

Provide the Account ID for the person that is reporting the issue.

b7b399c5b7c40279d7211271
Summary

Provide a string value for the summary of the issue.

This is an example summary.
Versions

Provide JSON data for the versions. You must supply a JSON array with an object containing an Id.

{
  "data": {
    "id": "10001",
    "key": "HSP-25",
    "self": "https://your-domain.atlassian.net/rest/api/3/issue/10001"
  }
}

Update Version​

Update an existing version by Id | key: updateVersion

InputNotesExample
Archived

This flag determines if the given version is archived.

false
Description

Provide a string value for the description of the issue.

This is an example summary.
Dynamic Fields

A field for dynamic inputs that can be configured at deploy time with the use of a key value config variable.

Values

The names of the fields and their values to use when creating/updating a record

projectId=1000,name=Example
Connection
Project ID

Provide the ID or Name of the Project.

10201
Project Key

Provide a string value for the key of the project.

JS-Example
Released

This flag determines if the given version has been released.

false
Release Date

Provide a valid date for the release of the given version.

2021-07-22
Start Date

Provide a value for the startDate.

2021-07-22
Version ID

Provide the ID of the Version.

10201
Version Name

Provide a string value for the name of the version.

2019.08.18

{
  "data": {
    "self": "https://your-domain.atlassian.net/rest/api/3/version/10000",
    "id": "10000",
    "description": "An excellent version",
    "name": "New Version 1",
    "archived": false,
    "released": true,
    "releaseDate": "2010-07-06",
    "userReleaseDate": "6/Jul/2010",
    "project": "PXA",
    "projectId": 10000
  }
}

Changelog​

2025-11-04​

Enhanced issue search and pagination capabilities:

  • Migrated Search Issues, Find Issue actions to JQL endpoint for improved query reliability
  • Added Fields input to control which issue fields are returned across search actions
  • Improved Find Issue action with corrected JQL query syntax
  • Replaced List Issues action with List Issues by Project to fulfill JQL requirements
  • Replaced Select Issue data source with Select Issue by Project to fulfill JQL requirements
  • Removed Query (Deprecated) action

2025-04-25​

Added inline data sources for boards, issues, priorities, and webhooks to enhance integration capabilities.