# Search Issues with JQL (POST) — Jira

> Searches for issues using JQL with enhanced search capabilities. See the documentation

- Key: `jira-search-issues-with-jql-post`
- Type: Action (Read-only)
- Version: 0.0.10
- App: Jira (`jira`) — https://pipedream.com/apps/jira.md
- This page (HTML): https://pipedream.com/apps/jira/actions/search-issues-with-jql-post
- Hints: read-only · open-world
- Source: https://github.com/PipedreamHQ/pipedream/blob/master/components/jira/actions/search-issues-with-jql-post/search-issues-with-jql-post.mjs

## Description

Searches for issues using JQL with enhanced search capabilities. [See the documentation](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-search/#api-rest-api-3-search-jql-post)

## Props

| Prop | Type | Required | Description |
|---|---|---|---|
| `cloudId` | `string` | Yes | The Jira Cloud site ID (for example, 11223344-a1b2-3b33-c444-def123456789). Use Get Cloud ID to discover IDs. See the documentation Options are loaded from the connected account. |
| `jql` | `string` | Yes | The JQL that defines the search. If no JQL expression is provided, all issues are returned. Note: username and userkey cannot be used as search terms due to privacy reasons. Use accountId instead |
| `maxResults` | `integer` | No | The maximum number of items to return per page |
| `nextPageToken` | `string` | No | Token for pagination. Use the token from a previous response to get the next page of results |
| `fields` | `string[]` | No | A list of fields to return for each issue. Use it to retrieve a subset of fields. Examples: summary,comment or *all,-comment |
| `expand` | `string[]` | No | Use expand to include additional information about issues in the response |
| `properties` | `string[]` | No | A list of issue property keys for issue properties to include in the results. A maximum of 5 issue property keys can be specified |
| `fieldsByKeys` | `boolean` | No | Reference fields by their key (rather than ID) |
| `reconcileIssues` | `string[]` | No | A list of issue IDs or keys to reconcile for read-after-write consistency. This ensures that recently created or updated issues are included in the search results |

## Run it

**MCP**

```ts
import { Client } from "@modelcontextprotocol/sdk/client/index.js"
import { StreamableHTTPClientTransport } from "@modelcontextprotocol/sdk/client/streamableHttp.js"
import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const accessToken = await pd.rawAccessToken

const transport = new StreamableHTTPClientTransport(
  new URL("https://remote.mcp.pipedream.net/v3"),
  {
    requestInit: {
      headers: {
        Authorization: `Bearer ${accessToken}`,
        "x-pd-project-id": process.env.PIPEDREAM_PROJECT_ID!,
        "x-pd-environment": "production",
        "x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
        "x-pd-app-slug": "jira",
      },
    },
  },
)

const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)

const { tools } = await mcp.listTools()

// listTools() hands your model this tool's input schema, so it can
// fill the arguments itself:
const result = await mcp.callTool({
  name: "jira-search-issues-with-jql-post",
  arguments: {
    cloudId: "Cloud ID",
    jql: "JQL Query",
  },
})
```

**TypeScript**

```ts
import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "jira-search-issues-with-jql-post",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    jira: { authProvisionId: "apn_xxxxxxx" },
    cloudId: "Cloud ID",
    jql: "JQL Query",
  },
})

console.log(result)
```

**cURL**

```bash
curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
  -H "Content-Type: application/json" \
  -H "X-PD-Environment: production" \
  -H "Authorization: Bearer {access_token}" \
  -d '{
    "external_user_id": "{external_user_id}",
    "id": "jira-search-issues-with-jql-post",
    "configured_props": {
      "jira": { "authProvisionId": "apn_xxxxxxx" },
      "cloudId": "Cloud ID",
      "jql": "JQL Query"
    }
  }'
```

---

- App: https://pipedream.com/apps/jira.md · All apps: https://pipedream.com/apps