Skip to main content

Jira Component

Manage issues, comments, projects, and users in Jira.

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 manage issues, comments, projects, and users within Jira.

API Documentation​

This component was built using the Jira Cloud REST API (v3)

Connections​

Basic Authentication​

To authenticate with Atlassian Jira using Basic Authentication, an email address and either an API token (for Jira Cloud) or password (for self-hosted Jira) is required.

Prerequisites​

  • Access to a Jira Cloud or self-hosted Jira instance
  • Administrative permissions to generate API tokens (for Jira Cloud)

Setup Steps​

For Jira Cloud:

  1. Navigate to Atlassian Account API Tokens
  2. Click Create API token
  3. Enter a label for the token and click Create
  4. Copy the generated API token value

For Self-Hosted Jira:

Use the standard account password for authentication. No additional setup is required.

Configure the Connection​

  • For Username, enter the email address associated with the Jira account
  • For API Key:
    • Jira Cloud: Enter the API token generated in the previous step
    • Self-Hosted Jira: Enter the account password
  • For Host, enter the Jira instance URL (e.g., example.atlassian.net for cloud or the self-hosted domain)
  • For Version, select the API version (typically 3 for Jira Cloud, 2 for older instances)

For more information on generating API tokens from Jira Cloud, refer to the Atlassian documentation.

Self-Hosted vs Cloud Authentication

Jira Cloud requires an API token for Basic Authentication, while self-hosted instances can use the account password. For security reasons, it is recommended to use API tokens whenever possible.

InputNotesExample
Host

The hostname of your Jira instance (without https://).

your-company.atlassian.net
API Key

Your Jira API token for authentication. Cloud users must generate an API token from Atlassian Account Settings.

ATATT3xFfGF0T8gK8Example1234567890abcdefGHIJKLMNOP
Username

Your Jira username or email address used for authentication.

john.doe@example.com
Version

Select the Jira API version to use for requests.

3

OAuth 2.0​

To create an Atlassian Jira OAuth 2.0 connection, an OAuth 2.0 integration must be configured in the Atlassian Developer Console.

Jira's Cloud API supports OAuth 2.0 (3LO) flows for secure authentication. For more information on OAuth 2.0 (3LO) apps, refer to Jira's OAuth 2.0 documentation.

Prerequisites​

Setup Steps​

  1. Navigate to the Atlassian Developer Console
  2. Click Create and select OAuth 2.0 integration
  3. Enter a name for the integration
  4. After creation, locate the App details section and copy the Client ID and Client Secret values
  5. Under the Authorization section, click Configure next to OAuth 2.0 (3LO)
  6. Enter the callback URL: https://oauth2.prismatic.io/callback
  7. Navigate to the Permissions tab
  8. Add the required scopes based on the use case:
    • For basic issue management, the following scopes are recommended: 
      read:jira-user read:jira-work write:jira-work manage:jira-project manage:jira-configuration manage:jira-webhook offline_access
    • Refer to Jira OAuth 2.0 scopes documentation for a complete list of available scopes
  9. Click Save to apply the configuration
Scope Consistency

The scopes configured in the Atlassian Developer Console must match the scopes entered in the connection configuration. Inconsistent scopes will cause authentication failures.

Configure the Connection​

  • Enter the Client ID from the Atlassian Developer Console

  • Enter the Client Secret from the Atlassian Developer Console

  • For Scopes, use the following default value:

    read:jira-user read:jira-work write:jira-work manage:jira-project manage:jira-configuration manage:jira-webhook offline_access
    • The offline_access scope is required to obtain a refresh token
    • Customize the scopes to match the use case requirements
    • Ensure the scopes match those configured in the Atlassian Developer Console
    • Refer to Jira scopes documentation for additional scope information

  • For Jira Site Name (optional):

    • By default, the connection uses the first Jira site the authenticated user has access to
    • To specify a different site, enter the site name (e.g., example) or full URL (e.g., example.atlassian.net)

  • For Version, select the API version (typically 3 for Jira Cloud)

For additional information on developing Jira applications and OAuth 2.0 configuration, refer to the Jira OAuth 2.0 apps guide.

InputNotesExample
Jira Site Name

Optional site name or URL to connect to. By default, connects to the first Jira site the user has access to. Use this if you have multiple Jira sites.

your-company.atlassian.net
Authorize URL

The OAuth 2.0 Authorization URL for Jira.

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

Your OAuth 2.0 Client ID from the Atlassian Developer Console.

c9e4APadFFkbtTycoNtrHKBtYgUyZWy
Client Secret

Your OAuth 2.0 Client Secret from the Atlassian Developer Console.

ntDBx4ao5czkFu7Mzp5FTlYG0y3_ukxkSiPhwnTkhsdKHJITGRCGP3ZWlXTYyu
Scopes

Space-delimited list of OAuth scopes for Jira access. For more information, see Jira OAuth 2.0 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 the Jira API version to use for requests.

3

Triggers​

Issue Events​

Receive real-time notifications when Jira issues are created, updated, or deleted. Automatically creates and manages a webhook subscription for selected issue events when the instance is deployed, and removes the subscription when the instance is deleted. | key: issueEventsTrigger

InputNotesExample
Event Types

Select the Jira events that will trigger this webhook.

jira:issue_created
Field IDs Filter

Optional list of field IDs to monitor. Only changes to these specific fields will trigger the webhook. Leave empty to monitor all field changes.

summary
Connection

The Jira connection to use.

JQL Filter

JQL (Jira Query Language) filter to limit which issues trigger the webhook. For more information, see JQL Documentation.

project = PROJ AND status = Done

The Issue Events trigger manages Jira webhook subscriptions for an instance. This trigger handles the entire webhook lifecycle automatically.

When the trigger is used in a flow:

  • On Instance Deploy: The trigger automatically creates a webhook subscription in Jira for the selected issue events (issue creation, updates, deletions, etc.). The webhook target URL is set to the instance's unique webhook URL. For OAuth connections, the webhook is registered with an expiration date and is automatically refreshed by the trigger. For Basic Auth connections, the webhook persists indefinitely.
  • On Instance Deletion: The trigger automatically removes the webhook subscription from Jira to ensure no orphaned webhook configurations remain after instance cleanup.

Authentication Methods​

This trigger supports both OAuth 2.0 and Basic Authentication, with different webhook registration behaviors:

OAuth 2.0:

  • Webhooks expire after 30 days and require periodic refresh
  • The trigger automatically refreshes the webhook on each invocation
  • Webhook payload structure uses the Dynamic Webhooks format
  • Requires OAuth connection with appropriate scopes

Basic Authentication:

  • Webhooks persist indefinitely without expiration
  • No automatic refresh required
  • Webhook payload structure uses the Classic Webhooks format
  • Requires Basic Auth connection with API token

Configuration Requirements​

This trigger requires a Jira connection configured in the Atlassian Jira component. The connection can be either:

  • OAuth 2.0 - Requires Client ID, Client Secret, and appropriate OAuth scopes for the events being subscribed to
  • Basic Auth - Requires Jira site URL, email address, and API token

Event Types Configuration​

When configuring the trigger, select which Jira issue events should trigger the flow. Available event types include:

Issue Lifecycle Events:

  • jira:issue_created - Triggered when a new issue is created
  • jira:issue_updated - Triggered when an issue is modified
  • jira:issue_deleted - Triggered when an issue is deleted

Additional Issue Events:

  • issue_property_set - Triggered when an issue property is set or updated
  • issue_property_deleted - Triggered when an issue property is deleted
  • jira:worklog_updated - Triggered when work is logged on an issue

Comment Events:

  • comment_created - Triggered when a comment is added to an issue
  • comment_updated - Triggered when a comment is modified
  • comment_deleted - Triggered when a comment is removed

Attachment Events:

  • attachment_created - Triggered when a file is attached to an issue
  • attachment_deleted - Triggered when an attachment is removed

A full list of available webhook events is available in the Jira Webhooks documentation.

Filtering Options​

The trigger provides powerful filtering capabilities to limit which issues trigger the flow:

JQL Filter (Required): Filter issues using Jira Query Language (JQL). This allows precise control over which issues trigger webhooks.

Examples:

  • project = PROJ - Only issues in the PROJ project
  • project IN (PROJ, TEST) AND status = Done - Issues in specific projects with Done status
  • assignee = currentUser() AND priority = High - High priority issues assigned to the current user

Field IDs Filter (Optional, OAuth only): Specify field IDs to monitor for changes. When provided, the webhook only triggers when those specific fields are updated. This is particularly useful for jira:issue_updated events.

Examples:

  • summary, description - Only trigger when summary or description changes
  • customfield_10029 - Only trigger when a specific custom field changes

Leave empty to trigger on any field change.

Returned Data​

The trigger returns the complete webhook payload from Jira, which varies based on the event type. All payloads include:

Common Properties:

  • webhookEvent - The event type that triggered the webhook
  • issue - Complete issue object with fields, status, priority, assignee, etc.
  • user - User who performed the action
  • changelog - For update events, lists what changed (old value, new value, field name)
Example payload for jira:issue_created event
{
  "webhookEvent": "jira:issue_created",
  "issue": {
    "id": "10001",
    "key": "PROJ-123",
    "self": "https://your-domain.atlassian.net/rest/api/3/issue/10001",
    "fields": {
      "summary": "New issue summary",
      "description": {
        "type": "doc",
        "version": 1,
        "content": [
          {
            "type": "paragraph",
            "content": [
              {
                "type": "text",
                "text": "Issue description"
              }
            ]
          }
        ]
      },
      "status": {
        "name": "To Do",
        "id": "10000"
      },
      "priority": {
        "name": "Medium",
        "id": "3"
      },
      "assignee": {
        "accountId": "5b10a2844c20165700ede21g",
        "displayName": "John Smith",
        "emailAddress": "john@example.com"
      },
      "project": {
        "id": "10000",
        "key": "PROJ",
        "name": "Example Project"
      },
      "issuetype": {
        "id": "10001",
        "name": "Task"
      },
      "created": "2024-11-10T10:30:00.000+0000",
      "updated": "2024-11-10T10:30:00.000+0000"
    }
  },
  "user": {
    "accountId": "5b10a2844c20165700ede21g",
    "displayName": "John Smith",
    "emailAddress": "john@example.com"
  },
  "timestamp": 1699614600000
}
Example payload for jira:issue_updated event
{
  "webhookEvent": "jira:issue_updated",
  "issue": {
    "id": "10001",
    "key": "PROJ-123",
    "fields": {
      "summary": "Updated issue summary",
      "status": {
        "name": "In Progress",
        "id": "10001"
      }
    }
  },
  "user": {
    "accountId": "5b10a2844c20165700ede21g",
    "displayName": "John Smith"
  },
  "changelog": {
    "items": [
      {
        "field": "status",
        "fieldtype": "jira",
        "from": "10000",
        "fromString": "To Do",
        "to": "10001",
        "toString": "In Progress"
      }
    ]
  },
  "timestamp": 1699614700000
}

Data Sources​

Issue Fields​

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

InputNotesExample
Connection

The Jira connection to use.

Only Custom Fieldsfalse

Select Board​

Select a board | key: selectBoard | type: picklist

InputNotesExample
Filter

The filter applied to the list of dashboards.

my
Connection

The Jira connection to use.

Max Results

The maximum number of results to return per page.

50
Start At

The index of the first item to return in the result set (0-based).

0

Select Board Version​

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

InputNotesExample
Board ID

The unique identifier of the Jira board.

10201
Connection

The Jira connection to use.

Max Results

The maximum number of results to return per page.

50
Start At

The index of the first item to return in the result set (0-based).

0

Select Issue by Project​

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

InputNotesExample
Connection

The Jira connection to use.

Project ID

The unique identifier or name of the Jira project.

10201

Select Issue Type from Project​

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

InputNotesExample
Connection

The Jira connection to use.

Project ID

The unique identifier or name of the Jira 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

The Jira connection to use.

Project ID(s)

One or more Jira 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

The Jira connection to use.

Project ID(s)

One or more Jira Project IDs.

10201

Select Priority​

Select a priority | key: selectPriority | type: picklist

InputNotesExample
Connection

The Jira connection to use.

Select Project​

Select a project | key: selectProject | type: picklist

InputNotesExample
Connection

The Jira connection to use.

Select Projects​

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

InputNotesExample
Connection

The Jira connection to use.

Select Webhook​

Select a webhook | key: selectWebhook | type: picklist

InputNotesExample
Connection

The Jira connection to use.

Actions​

Add Comment​

Add a comment to an existing issue | key: addComment

InputNotesExample
Comment

The text content of the comment to add or update.

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

The unique identifier of the Jira issue.

10201
Connection

The Jira connection to use.

{
  "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

The unique identifier of the Jira issue.

10201
Connection

The Jira connection to use.

{
  "data": [
    {
      "self": "https://your-domain.atlassian.net/rest/api/2/attachment/10001",
      "id": "10001",
      "filename": "document.pdf",
      "author": {
        "self": "https://your-domain.atlassian.net/rest/api/2/user?accountId=5b10ac8d82e05b22cc7d4ef5",
        "accountId": "5b10ac8d82e05b22cc7d4ef5",
        "displayName": "John Doe",
        "active": true
      },
      "created": "2024-01-15T10:30:00.000+0000",
      "size": 1024000,
      "mimeType": "application/pdf",
      "content": "https://your-domain.atlassian.net/secure/attachment/10001/document.pdf",
      "thumbnail": "https://your-domain.atlassian.net/secure/thumbnail/10001"
    }
  ]
}

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

The Atlassian account ID of the user to assign the issue to.

5b10a2844c20165700ede21g
Description

A detailed description of the issue.

The login button does not respond on mobile devices in portrait mode.
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

The Jira connection to use.

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

The unique identifier or name of the Jira project.

10201
Reporter Account ID

The Atlassian account ID of the user reporting the issue.

5b10a2844c20165700ede21g
Summary

A brief summary or title for the issue.

Fix login page responsiveness
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

The display name for the user account.

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

The Jira connection to use.

Notifications

When true, the user will receive email notifications for relevant events.

false
Password

The password to assign to the user account.

Username

The username for the Jira user account.

john.doe

{
  "data": {
    "self": "https://your-domain.atlassian.net/rest/api/2/user?username=newuser",
    "key": "newuser",
    "name": "newuser",
    "emailAddress": "newuser@example.com",
    "displayName": "New User",
    "active": true,
    "timeZone": "America/Los_Angeles"
  }
}

Create Version​

Create a new version | key: createVersion

InputNotesExample
Archived

When true, marks the version as archived.

false
Description

A detailed description of the issue.

The login button does not respond on mobile devices in portrait mode.
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

The Jira connection to use.

Project ID

The unique identifier or name of the Jira project.

10201
Project Key

The project key identifier (e.g., PROJ, ENG, SALES).

PROJ
Released

When true, marks the version as 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

The Jira connection to use.

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

The unique identifier of the comment.

10201
Issue ID

The unique identifier of the Jira issue.

10201
Connection

The Jira connection to use.

{
  "data": {}
}

Delete Issue​

Delete an issue by id | key: deleteIssue

InputNotesExample
Issue ID

The unique identifier of the Jira issue.

10201
Connection

The Jira connection to use.

{
  "data": {}
}

Delete Webhook​

Delete a webhook by ID | key: deleteWebhook

InputNotesExample
Connection

The Jira connection to use.

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

The Jira connection to use.

{
  "data": [
    {
      "filename": "document.pdf",
      "data": {
        "type": "Buffer",
        "data": [
          98,
          97,
          115,
          101,
          54,
          52,
          45,
          101,
          110,
          99,
          111,
          100,
          101,
          100,
          45,
          102,
          105,
          108,
          101,
          45,
          100,
          97,
          116,
          97
        ]
      },
      "contentType": "application/pdf"
    }
  ]
}

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

The Jira connection to use.

Search Type

Attribute to search

Search Value

Value to search for

{
  "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": "PROJ-123",
        "fields": {
          "summary": "Found issue matching criteria",
          "issueType": {
            "name": "Task",
            "id": "10001"
          },
          "project": {
            "key": "PROJ",
            "name": "Project Name",
            "id": "10000"
          },
          "status": {
            "name": "In Progress",
            "id": "3"
          }
        }
      }
    ]
  }
}

Find Project​

Find Project by attribute | key: findProject

InputNotesExample
Connection

The Jira connection to use.

Search Type

Attribute to search

Search Value

Value to search for

{
  "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"
    }
  ]
}

Find User​

Find User by attribute | key: findUser

InputNotesExample
Connection

The Jira connection to use.

Search Value

Value to search for

{
  "data": [
    {
      "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
      "accountId": "5b10a2844c20165700ede21g",
      "accountType": "atlassian",
      "avatarUrls": {
        "48x48": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/48x48.png",
        "24x24": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/24x24.png",
        "16x16": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/16x16.png",
        "32x32": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/32x32.png"
      },
      "displayName": "John Smith",
      "active": true
    }
  ]
}

Get Board​

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

InputNotesExample
Board ID

The unique identifier of the Jira board.

10201
Connection

The Jira connection to use.

{
  "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

The unique identifier of the Jira issue.

10201
Connection

The Jira connection to use.

{
  "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

The Jira connection to use.

{
  "data": {
    "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
    "accountId": "5b10a2844c20165700ede21g",
    "accountType": "atlassian",
    "emailAddress": "current.user@example.com",
    "avatarUrls": {
      "48x48": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/48x48.png",
      "24x24": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/24x24.png",
      "16x16": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/16x16.png",
      "32x32": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/32x32.png"
    },
    "displayName": "Current User",
    "active": true,
    "timeZone": "America/New_York",
    "locale": "en_US"
  }
}

Get Issue​

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

InputNotesExample
Issue ID

The unique identifier of the Jira issue.

10201
Connection

The Jira connection to use.

{
  "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

The Jira connection to use.

Project ID

The unique identifier or name of the Jira 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

The Jira connection to use.

Max Results

The maximum number of results to return per page.

50
Project ID

The unique identifier or name of the Jira project.

10201
Start At

The index of the first item to return in the result set (0-based).

0

{
  "data": {
    "self": "https://your-domain.atlassian.net/rest/api/3/statuses/search",
    "nextPage": "https://your-domain.atlassian.net/rest/api/3/statuses/search?startAt=2",
    "maxResults": 2,
    "startAt": 0,
    "total": 5,
    "isLast": false,
    "values": [
      {
        "id": "1",
        "name": "To Do",
        "statusCategory": "TODO",
        "scope": {
          "type": "PROJECT",
          "project": {
            "id": "10000"
          }
        }
      },
      {
        "id": "3",
        "name": "In Progress",
        "statusCategory": "IN_PROGRESS",
        "scope": {
          "type": "PROJECT",
          "project": {
            "id": "10000"
          }
        }
      }
    ]
  }
}

Get User​

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

InputNotesExample
Account ID

The unique Atlassian account ID of the user.

5b10a2844c20165700ede21g
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

The Jira connection to use.

{
  "data": {
    "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
    "accountId": "5b10a2844c20165700ede21g",
    "accountType": "atlassian",
    "emailAddress": "john.doe@example.com",
    "avatarUrls": {
      "48x48": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/48x48.png",
      "24x24": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/24x24.png",
      "16x16": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/16x16.png",
      "32x32": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/32x32.png"
    },
    "displayName": "John Doe",
    "active": true,
    "timeZone": "America/Los_Angeles",
    "locale": "en_US",
    "groups": {
      "size": 3,
      "items": []
    },
    "applicationRoles": {
      "size": 1,
      "items": []
    },
    "expand": "groups,applicationRoles"
  }
}

Get Version​

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

InputNotesExample
Connection

The Jira connection to use.

Version ID

The unique identifier of the version.

10201

{
  "data": {
    "self": "https://your-domain.atlassian.net/rest/api/3/version/10000",
    "id": "10000",
    "description": "An excellent version",
    "name": "Version 1.0",
    "archived": false,
    "released": true,
    "releaseDate": "2024-01-15",
    "overdue": false,
    "userReleaseDate": "15/Jan/2024",
    "projectId": 10000,
    "project": "PROJ"
  }
}

List Assignable Users for Project​

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

InputNotesExample
Connection

The Jira connection to use.

Max Results

The maximum number of results to return per page.

50
Project Key

The project key identifier (e.g., PROJ, ENG, SALES).

PROJ
Start At

The index of the first item to return in the result set (0-based).

0

{
  "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

The unique identifier of the Jira board.

10201
Connection

The Jira connection to use.

Max Results

The maximum number of results to return per page.

50
Start At

The index of the first item to return in the result set (0-based).

0

{
  "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

The Jira connection to use.

Max Results

The maximum number of results to return per page.

50
Start At

The index of the first item to return in the result set (0-based).

0

{
  "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

The unique identifier of the Jira issue.

10201
Connection

The Jira connection to use.

List Issue Custom Fields​

List all configured issue fields | key: listIssueCustomFields

InputNotesExample
Connection

The Jira connection to use.

{
  "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

The Jira connection to use.

{
  "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 Issue Link Types​

List all available issue link types | key: listIssueLinkTypes

InputNotesExample
Connection

The Jira connection to use.

{
  "data": {
    "issueLinkTypes": [
      {
        "id": "10000",
        "name": "Blocks",
        "inward": "is blocked by",
        "outward": "blocks",
        "self": "https://your-domain.atlassian.net/rest/api/3/issueLinkType/10000"
      },
      {
        "id": "10001",
        "name": "Cloners",
        "inward": "is cloned by",
        "outward": "clones",
        "self": "https://your-domain.atlassian.net/rest/api/3/issueLinkType/10001"
      },
      {
        "id": "10002",
        "name": "Duplicate",
        "inward": "is duplicated by",
        "outward": "duplicates",
        "self": "https://your-domain.atlassian.net/rest/api/3/issueLinkType/10002"
      }
    ]
  }
}

List Issue Transitions​

Returns a list of issue transitions | key: listIssueTransitions

InputNotesExample
Issue ID

The unique identifier of the Jira issue.

10201
Connection

The Jira connection to use.

{
  "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

The Jira connection to use.

{
  "data": [
    {
      "self": "https://your-domain.atlassian.net/rest/api/3/issuetype/10000",
      "id": "10000",
      "description": "A task that needs to be done.",
      "iconUrl": "https://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10318",
      "name": "Task",
      "subtask": false,
      "avatarId": 10318,
      "hierarchyLevel": 0
    },
    {
      "self": "https://your-domain.atlassian.net/rest/api/3/issuetype/10001",
      "id": "10001",
      "description": "A problem that needs to be fixed.",
      "iconUrl": "https://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10303",
      "name": "Bug",
      "subtask": false,
      "avatarId": 10303,
      "hierarchyLevel": 0
    },
    {
      "self": "https://your-domain.atlassian.net/rest/api/3/issuetype/10002",
      "id": "10002",
      "description": "A new feature that needs to be implemented.",
      "iconUrl": "https://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10310",
      "name": "Story",
      "subtask": false,
      "avatarId": 10310,
      "hierarchyLevel": 0
    }
  ]
}

List Issue Worklogs​

Returns a list of issue worklogs | key: listIssueWorklogs

InputNotesExample
Issue ID

The unique identifier of the Jira issue.

10201
Connection

The Jira connection to use.

{
  "data": {
    "startAt": 0,
    "maxResults": 2,
    "total": 2,
    "worklogs": [
      {
        "self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000",
        "author": {
          "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
          "accountId": "5b10a2844c20165700ede21g",
          "displayName": "John Doe",
          "active": true
        },
        "updateAuthor": {
          "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
          "accountId": "5b10a2844c20165700ede21g",
          "displayName": "John Doe",
          "active": true
        },
        "comment": {
          "type": "doc",
          "version": 1,
          "content": [
            {
              "type": "paragraph",
              "content": [
                {
                  "type": "text",
                  "text": "Worked on implementing new feature"
                }
              ]
            }
          ]
        },
        "created": "2024-01-15T09:00:00.000+0000",
        "updated": "2024-01-15T09:00:00.000+0000",
        "started": "2024-01-15T08:00:00.000+0000",
        "timeSpent": "3h",
        "timeSpentSeconds": 10800,
        "id": "10000",
        "issueId": "10010"
      },
      {
        "self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10001",
        "author": {
          "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
          "accountId": "5b10a2844c20165700ede21g",
          "displayName": "John Doe",
          "active": true
        },
        "updateAuthor": {
          "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
          "accountId": "5b10a2844c20165700ede21g",
          "displayName": "John Doe",
          "active": true
        },
        "created": "2024-01-16T14:00:00.000+0000",
        "updated": "2024-01-16T14:00:00.000+0000",
        "started": "2024-01-16T13:00:00.000+0000",
        "timeSpent": "2h 30m",
        "timeSpentSeconds": 9000,
        "id": "10001",
        "issueId": "10010"
      }
    ]
  }
}

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

The Jira connection to use.

Max Results

The maximum number of results to return per page.

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

The unique identifier or name of the Jira 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

The Jira connection to use.

Max Results

The maximum number of results to return per page.

50
Start At

The index of the first item to return in the result set (0-based).

0

{
  "data": {
    "self": "https://your-domain.atlassian.net/rest/api/3/priority/search",
    "nextPage": "https://your-domain.atlassian.net/rest/api/3/priority/search?startAt=3",
    "maxResults": 3,
    "startAt": 0,
    "total": 5,
    "isLast": false,
    "values": [
      {
        "self": "https://your-domain.atlassian.net/rest/api/3/priority/1",
        "statusColor": "#d04437",
        "description": "This problem will block progress.",
        "iconUrl": "https://your-domain.atlassian.net/images/icons/priorities/highest.svg",
        "name": "Highest",
        "id": "1"
      },
      {
        "self": "https://your-domain.atlassian.net/rest/api/3/priority/2",
        "statusColor": "#ea7d24",
        "description": "Serious problem that could block progress.",
        "iconUrl": "https://your-domain.atlassian.net/images/icons/priorities/high.svg",
        "name": "High",
        "id": "2"
      },
      {
        "self": "https://your-domain.atlassian.net/rest/api/3/priority/3",
        "statusColor": "#59afe1",
        "description": "Has the potential to affect progress.",
        "iconUrl": "https://your-domain.atlassian.net/images/icons/priorities/medium.svg",
        "name": "Medium",
        "id": "3"
      }
    ]
  }
}

List Projects​

Retrieve a list of all projects | key: listProjects

InputNotesExample
Connection

The Jira connection to use.

Max Results

The maximum number of results to return per page.

50
Start At

The index of the first item to return in the result set (0-based).

0

{
  "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

The Jira connection to use.

Max Results

The maximum number of results to return per page.

50
Project ID

The unique identifier or name of the Jira project.

10201
Start At

The index of the first item to return in the result set (0-based).

0

{
  "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

When true, automatically fetches all pages of results using pagination.

false
Connection

The Jira connection to use.

{
  "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

The Jira connection to use.

Max Results

The maximum number of results to return per page.

50
Search

The search term to use when searching for records.

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

{
  "data": {
    "expand": "names,schema",
    "startAt": 0,
    "maxResults": 50,
    "total": 2,
    "issues": [
      {
        "expand": "",
        "id": "10001",
        "self": "https://your-domain.atlassian.net/rest/api/3/issue/10001",
        "key": "PROJ-1",
        "fields": {
          "summary": "First matching issue",
          "status": {
            "name": "To Do",
            "id": "1"
          }
        }
      },
      {
        "expand": "",
        "id": "10002",
        "self": "https://your-domain.atlassian.net/rest/api/3/issue/10002",
        "key": "PROJ-2",
        "fields": {
          "summary": "Second matching issue",
          "status": {
            "name": "In Progress",
            "id": "3"
          }
        }
      }
    ]
  }
}

Raw Request​

Send raw HTTP request to Jira | key: rawRequest

InputNotesExample
Connection

The Jira connection to use.

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

The Jira connection to use.

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

The Jira connection to use.

Project Key

The project key identifier (e.g., PROJ, ENG, SALES).

PROJ
Search

The search term to use when searching for records.

login bug

{
  "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

The Jira connection to use.

Search

The search term to use when searching for records.

login bug

{
  "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"
    },
    {
      "expand": "description,lead,url,projectKeys",
      "self": "https://your-domain.atlassian.net/rest/api/3/project/DEMO",
      "id": "10001",
      "key": "DEMO",
      "name": "Demo Project",
      "projectTypeKey": "business",
      "simplified": true,
      "style": "classic"
    }
  ]
}

Search Users​

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

InputNotesExample
Connection

The Jira connection to use.

Search

The search term to use when searching for records.

login bug

{
  "data": [
    {
      "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
      "accountId": "5b10a2844c20165700ede21g",
      "accountType": "atlassian",
      "avatarUrls": {
        "48x48": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/48x48.png",
        "24x24": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/24x24.png",
        "16x16": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/16x16.png",
        "32x32": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/32x32.png"
      },
      "displayName": "Jane Doe",
      "active": true
    },
    {
      "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede22h",
      "accountId": "5b10a2844c20165700ede22h",
      "accountType": "atlassian",
      "avatarUrls": {
        "48x48": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede22h/48x48.png",
        "24x24": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede22h/24x24.png",
        "16x16": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede22h/16x16.png",
        "32x32": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede22h/32x32.png"
      },
      "displayName": "Bob Wilson",
      "active": true
    }
  ]
}

Transition Issue​

Transition an existing issue by Id | key: transitionIssue

InputNotesExample
Issue ID

The unique identifier of the Jira issue.

10201
Connection

The Jira connection to use.

Transition ID

The unique identifier of the issue transition.

21

{
  "data": {}
}

Update Comment​

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

InputNotesExample
Comment

The text content of the comment to add or update.

This is an example comment.
Comment ID

The unique identifier of the comment.

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

The unique identifier of the Jira issue.

10201
Connection

The Jira connection to use.

{
  "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

The Atlassian account ID of the user to assign the issue to.

5b10a2844c20165700ede21g
Description

A detailed description of the issue.

The login button does not respond on mobile devices in portrait mode.
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

The unique identifier of the Jira 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

The Jira connection to use.

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

The unique identifier or name of the Jira project.

10201
Reporter Account ID

The Atlassian account ID of the user reporting the issue.

5b10a2844c20165700ede21g
Summary

A brief summary or title for the issue.

Fix login page responsiveness
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

When true, marks the version as archived.

false
Description

A detailed description of the issue.

The login button does not respond on mobile devices in portrait mode.
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

The Jira connection to use.

Project ID

The unique identifier or name of the Jira project.

10201
Project Key

The project key identifier (e.g., PROJ, ENG, SALES).

PROJ
Released

When true, marks the version as 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

The unique identifier 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-12-10​

Added Issue Events trigger with automatic webhook lifecycle management for issue, comment, and attachment events

2025-11-04​

Enhanced issue search and pagination capabilities:

  • Migrated Search Issues and 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