> ## Documentation Index
> Fetch the complete documentation index at: https://nango-wari-migrated-bigcommerce-docs.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Jira

> Integrate your application with the Jira API

## 🚀 Quickstart

Connect to Jira with Nango and see data flow in 2 minutes.

<Steps>
  <Step title="Create the integration">
    In Nango ([free signup](https://app.nango.dev)), go to [Integrations](https://app.nango.dev/dev/integrations) -> *Configure New Integration* -> *Jira*.
  </Step>

  <Step title="Authorize Jira">
    Go to [Connections](https://app.nango.dev/dev/connections) -> *Add Test Connection* -> *Authorize*, then log in to Jira. Later, you'll let your users do the same directly from your app.
  </Step>

  <Step title="Call the Jira API">
    Let's make your first request to the Jira API (fetch a list of issues). Replace the placeholders below with your [secret key](https://app.nango.dev/dev/environment-settings), [integration ID](https://app.nango.dev/dev/integrations), and [connection ID](https://app.nango.dev/dev/connections):

    <Tabs>
      <Tab title="cURL">
        ```bash theme={null}
        curl "https://api.nango.dev/proxy/ex/jira/{connectionConfig.cloudId}/rest/api/3/search?maxResults=10" \
          -H "Authorization: Bearer <NANGO-SECRET-KEY>" \
          -H "Provider-Config-Key: <INTEGRATION-ID>" \
          -H "Connection-Id: <CONNECTION-ID>"
        ```
      </Tab>

      <Tab title="Node">
        Install Nango's backend SDK with `npm i @nangohq/node`. Then run:

        ```typescript theme={null}
        import { Nango } from '@nangohq/node';

        const nango = new Nango({ secretKey: '<NANGO-SECRET-KEY>' });

        const res = await nango.get({
            endpoint: '/ex/jira/{connectionConfig.cloudId}/rest/api/3/search',
            params: {
              maxResults: 10
            },
            providerConfigKey: '<INTEGRATION-ID>',
            connectionId: '<CONNECTION-ID>'
        });

        console.log(JSON.stringify(res.data, null, 2));
        ```
      </Tab>
    </Tabs>

    Or fetch credentials with the [Node SDK](/reference/sdks/node#get-a-connection-with-credentials) or [API](/reference/api/connection/get).

    <Note>
      The `{connectionConfig.cloudId}` in the URL represents the cloudId. You can get this value from your connection configuration after creating the connection. The cloudId is automatically set by Nango.
    </Note>

    ✅ You're connected! Check the [Logs](https://app.nango.dev/dev/logs) tab in Nango to inspect requests.
  </Step>

  <Step title="Implement Nango in your app">
    Follow our [Auth implementation guide](/guides/primitives/auth) to integrate Nango in your app.

    To obtain your own production credentials, follow the setup guide linked below.
  </Step>
</Steps>

## 📚 Jira Integration Guides

Nango maintained guides for common use cases.

* [How to register your own Jira OAuth app](/api-integrations/jira/how-to-register-your-own-jira-api-oauth-app)\
  Register an OAuth app with Jira and obtain credentials to connect it to Nango
* [How to set up webhooks with Jira on Nango](/api-integrations/jira/webhooks)\
  Receive real-time Jira events in your app

Official docs: [Jira REST API v3 Documentation](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/)

## 🧩 Pre-built syncs & actions for Jira

Enable them in your dashboard. Extend and customize to fit your needs.

### Others

| Function name               | Description                                                       | Type                                           | Source code                                                                                                                    |
| --------------------------- | ----------------------------------------------------------------- | ---------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ |
| `add-attachment`            | Attach a file to a Jira issue                                     | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/jira/actions/add-attachment.ts)            |
| `add-comment`               | Add a comment to a Jira issue.                                    | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/jira/actions/add-comment.ts)               |
| `add-watcher`               | Add a watcher to a Jira issue                                     | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/jira/actions/add-watcher.ts)               |
| `add-worklog`               | Log time against a Jira issue.                                    | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/jira/actions/add-worklog.ts)               |
| `create-issue-link`         | Link two Jira issues with a relationship type                     | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/jira/actions/create-issue-link.ts)         |
| `create-issue`              | Create a Jira issue in a project.                                 | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/jira/actions/create-issue.ts)              |
| `delete-attachment`         | Delete an attachment from a Jira issue                            | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/jira/actions/delete-attachment.ts)         |
| `delete-comment`            | Delete a comment from a Jira issue                                | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/jira/actions/delete-comment.ts)            |
| `delete-issue-link`         | Delete a link between Jira issues                                 | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/jira/actions/delete-issue-link.ts)         |
| `delete-issue`              | Delete a Jira issue by ID or key                                  | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/jira/actions/delete-issue.ts)              |
| `delete-worklog`            | Delete a worklog from a Jira issue.                               | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/jira/actions/delete-worklog.ts)            |
| `get-create-issue-metadata` | Retrieve project and issue type metadata for issue creation.      | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/jira/actions/get-create-issue-metadata.ts) |
| `get-edit-issue-metadata`   | Retrieve editable field metadata for an existing Jira issue       | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/jira/actions/get-edit-issue-metadata.ts)   |
| `get-field`                 | Retrieve Jira field metadata by field ID                          | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/jira/actions/get-field.ts)                 |
| `get-issue-changelog`       | Retrieve the changelog for a Jira issue                           | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/jira/actions/get-issue-changelog.ts)       |
| `get-issue-type`            | Retrieve Jira issue type metadata by issue type ID.               | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/jira/actions/get-issue-type.ts)            |
| `get-issue`                 | Retrieve a Jira issue by ID or key                                | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/jira/actions/get-issue.ts)                 |
| `get-myself`                | Retrieve the currently authenticated Jira user.                   | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/jira/actions/get-myself.ts)                |
| `get-priority`              | Retrieve a Jira priority by priority ID.                          | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/jira/actions/get-priority.ts)              |
| `get-project`               | Retrieve a Jira project by ID or key.                             | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/jira/actions/get-project.ts)               |
| `get-status`                | Retrieve a Jira status by status ID or name.                      | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/jira/actions/get-status.ts)                |
| `get-user`                  | Retrieve a Jira user by account ID                                | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/jira/actions/get-user.ts)                  |
| `list-fields`               | List Jira field metadata available to the user.                   | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/jira/actions/list-fields.ts)               |
| `list-issue-comments`       | List comments on a Jira issue with pagination                     | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/jira/actions/list-issue-comments.ts)       |
| `list-issue-types`          | List Jira issue types available to the user                       | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/jira/actions/list-issue-types.ts)          |
| `list-priorities`           | List Jira priorities available to the user.                       | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/jira/actions/list-priorities.ts)           |
| `list-project-components`   | List components for a Jira project                                | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/jira/actions/list-project-components.ts)   |
| `list-project-versions`     | List versions for a Jira project                                  | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/jira/actions/list-project-versions.ts)     |
| `list-projects`             | List Jira projects accessible to the authenticated user.          | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/jira/actions/list-projects.ts)             |
| `list-statuses`             | List Jira statuses available to the user                          | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/jira/actions/list-statuses.ts)             |
| `list-transitions`          | List available workflow transitions for a Jira issue              | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/jira/actions/list-transitions.ts)          |
| `list-users`                | Search Jira users visible to the authenticated account.           | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/jira/actions/list-users.ts)                |
| `list-watchers`             | List watchers on a Jira issue                                     | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/jira/actions/list-watchers.ts)             |
| `list-worklogs`             | List worklogs on a Jira issue                                     | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/jira/actions/list-worklogs.ts)             |
| `remove-watcher`            | Remove a watcher from a Jira issue                                | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/jira/actions/remove-watcher.ts)            |
| `search-issues`             | Search Jira issues using JQL.                                     | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/jira/actions/search-issues.ts)             |
| `transition-issue`          | Move a Jira issue through a workflow transition.                  | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/jira/actions/transition-issue.ts)          |
| `update-comment`            | Update a comment on a Jira issue                                  | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/jira/actions/update-comment.ts)            |
| `update-issue`              | Update issue fields on an existing Jira issue                     | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/jira/actions/update-issue.ts)              |
| `update-worklog`            | Update a worklog on a Jira issue.                                 | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/jira/actions/update-worklog.ts)            |
| `fields`                    | Sync Jira field metadata available to the authenticated user.     | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/jira/syncs/fields.ts)                      |
| `issue-types`               | Sync Jira issue types available to the authenticated user         | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/jira/syncs/issue-types.ts)                 |
| `issues`                    | Sync Jira issues using JQL-backed search with incremental updates | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/jira/syncs/issues.ts)                      |
| `project-components`        | Sync Jira project components for projects in scope                | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/jira/syncs/project-components.ts)          |
| `project-versions`          | Sync Jira project versions for projects in scope                  | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/jira/syncs/project-versions.ts)            |
| `projects`                  | Sync Jira projects accessible to the authenticated user.          | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/jira/syncs/projects.ts)                    |
| `users`                     | Sync Jira users visible to the authenticated account              | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/jira/syncs/users.ts)                       |

***