> ## Documentation Index
> Fetch the complete documentation index at: https://nango.dev/docs/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.

**1. Create the integration**

In Nango ([free signup](https://app.nango.dev)), go to [Integrations](https://app.nango.dev/dev/integrations) -> *Configure New Integration* -> *Jira*.

> [!NOTE]
>
> Nango has a [Nango-managed OAuth app](https://nango.dev/docs/guides/auth/auth-guide.md#nango-managed-oauth-apps) you can use in development and production. Select it when you create the integration.

**2. 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.

**3. 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 [Environment API key](https://nango.dev/docs/reference/backend/http-api/api-keys.md), [integration ID](https://app.nango.dev/dev/integrations), and [connection ID](https://app.nango.dev/dev/connections):

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

> [tab] 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({ apiKey: '<NANGO-API-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));
> ```

Or fetch credentials with the [Node SDK](https://nango.dev/docs/reference/backend/backend-sdk/node.md#get-a-connection-with-credentials) or [API](https://nango.dev/docs/reference/backend/http-api/connections/get.md).

> [!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.

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

**4. Implement Nango in your app**

Follow our [Auth implementation guide](https://nango.dev/docs/guides/primitives/auth.md) to integrate Nango in your app.

To use your own OAuth app instead of the Nango-managed one, follow the setup guide linked below.

## 📚 Jira Integration Guides

Nango maintained guides for common use cases.

* [How to register your own Jira OAuth app](https://nango.dev/docs/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](https://nango.dev/docs/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 & tools for Jira

Explore Nango-provided tools in your dashboard. Extend and customize them to fit your needs.

### Others

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

***


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.