Get issue with the Jira API
Returns one issue by id or key, with all navigable fields unless fields lists what to include.
- Identifier
- jira_get_issue
The request
POST https://connect.reportei.com/api/tools/jira_get_issue/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"issueIdOrKey": "<issueIdOrKey>"
}
}Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| issueIdOrKey | string | Yes | Issue id or key, for example KEY-123, from Search issues. |
| fields | string | No | Comma-separated field names to return. Omit it to return all navigable fields. |
Supported connections
Your customer connects their Jira account once, with one of the modes below. The same connection serves every tool of the toolkit.
Username and password
Your customer enters the app credentials on a Connect screen, or your system sends them with POST /api/customer-toolkits, with no screen.
When connecting, your customer also enters {site}: the address of their account on the app's API.
The response
On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.
Ready for AI agents
This tool's input is a JSON Schema, available at GET /api/tools/jira_get_issue. It becomes your agent's tool definition with no conversion.
Other Jira tools
- Search issuesGETSearches issues with JQL. The query must be bounded, for example project = KEY. Only the issue id comes back unless fields lists what to include. Pass the nextPageToken of the response to read the next page.
- Create issuePOSTCreates an issue. fields needs at least project, issuetype and summary, and any other field must exist on the create screen of the project, as List create fields shows. In this API version the description field takes an Atlassian Document Format object, not plain text.
- Update issuePUTEdits the fields of an issue: fields sets values, and update applies operations such as adding or removing one label. A field goes in fields or in update, never both. The status does not change here: use Transition issue. The response is empty, status 204, unless returnIssue is true.
- Delete issueDELETEDeletes an issue. An issue with subtasks is only deleted with deleteSubtasks set to true, which deletes them too. Needs the Delete issues permission in the project. The response is empty, status 204.
- List transitionsGETLists the transitions the user can make on an issue now, each with the id that Transition issue takes, its name and the status it leads to in to.
- Transition issuePOSTMoves an issue to another status by running one of its transitions. When the transition has a screen, its required fields, such as resolution, go in fields or update. The response is empty, status 204.
- List commentsGETLists the comments of an issue, with the body in Atlassian Document Format. Page with startAt and maxResults until startAt plus the returned count reaches total.
- Create commentPOSTAdds a comment to an issue, visible to everyone who can see the issue. Jira notifies the watchers by the notification scheme of the project. Returns the new comment.
See Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
