Reconcile Issues parameter to ensure stronger consistency assurances.
Permissions required:
Browse projects(for the project containing the issue).- If issue-level security is configured, the user needs permissions to view the issue.
External DocumentationTo learn more, visit the Jira documentation.
Basic Parameters
| Parameter | Description |
|---|---|
| Fields | A comma-separated list of fields to return for each issue. Options: (Defaults to id)* *all - Returns all fields.* *navigable - Returns navigable fields.* id - Returns only issue IDs.* Any issue field, prefixed with a minus to exclude. Examples: * summary,comment Returns only the summary and comments fields only.* -description Returns all navigable (default) fields except description.* *all,-comment Returns all fields except comments. |
| Limit | The maximum number of items to return per page. |
| Next Page Token | The token for a page to fetch (that is not the first page). Note: The token is not included in the response for the last page (indicating that there is no next page). |
| Query | A JQL expression. Note: This parameter requires a bounded query (with a search restriction). An unbounded expression can be added to the JQL query. Example of a valid bounded query: * project = ‘example’ Example of a mixed query that incorporates both bounded and unbounded expressions: * project = ‘example’ ORDER BY key DESC Note: ORDER BY clause can contain a maximum of 7 fields. |
| Use Instance Timezone | When checked, your Jira instance timezone will be used when writing JQL date filters. |
Advanced Parameters
| Parameter | Description |
|---|---|
| Expand | Select options of additional information to include in the response. Options: * renderedFields - Returns field values rendered in HTML format.* names - Returns the display name of each field.* schema - Returns the schema describing a field type.* transitions - Returns all possible transitions for the issue.* operations - Returns all possible operations for the issue.* editmeta - Returns information about how each field can be edited.* changelog - Returns a list of recent updates to an issue, sorted by date, starting from the most recent.* versionedRepresentations - Returns a JSON array containing each version of a field’s value, with the highest numbered item representing the most recent version. |
| Fail Fast | Select to stop the request early if Jira can’t retrieve all the fields. |
| Fields By Keys | Select to reference the fields by their key (rather than ID). |
| Properties | A comma-separated list of up to 5 issue properties to include in the results. |
| Reconcile Issues | A comma-separated list of IDs, representing issues that require strong consistency reconciliation with search results.(Maximum 50 IDs). |
Example Output
{
"issues": [
{
"expand": "<string>",
"id": "<string>",
"self": "<string>",
"key": "<string>",
"fields": {
"statuscategorychangedate": "2025-03-12T21:01:42.757+0000",
"issuetype": {
"self": "<string>",
"id": "<string>",
"description": "<string>",
"iconUrl": "<string>",
"name": "<string>",
"subtask": false,
"avatarId": 11964,
"entityId": "<string>",
"hierarchyLevel": 2
},
"components": [],
"timespent": null,
"timeoriginalestimate": null,
"project": {
"self": "<string>",
"id": "<string>",
"key": "<string>",
"name": "<string>",
"projectTypeKey": "<string>",
"simplified": true,
"avatarUrls": {
"48x48": "<string>",
"24x24": "<string>",
"16x16": "<string>",
"32x32": "<string>"
}
},
"description": null,
"fixVersions": [],
"statusCategory": {
"self": "<string>",
"id": 3,
"key": "<string>",
"colorName": "<string>",
"name": "<string>"
},
"aggregatetimespent": null,
"resolution": null,
"timetracking": {},
"security": null,
"attachment": [],
"aggregatetimeestimate": null,
"resolutiondate": null,
"workratio": 2,
"summary": "<string>",
"watches": {
"self": "<string>",
"watchCount": 0,
"isWatching": true
},
"issuerestriction": {
"issuerestrictions": {},
"shouldDisplay": true
},
"lastViewed": null,
"creator": {
"self": "<string>",
"accountId": "<string>",
"emailAddress": "<string>",
"avatarUrls": {
"48x48": "<string>",
"24x24": "<string>",
"16x16": "<string>",
"32x32": "<string>"
},
"displayName": "<string>",
"active": true,
"timeZone": "<string>",
"accountType": "<string>"
},
"subtasks": [],
"created": "<string>",
"reporter": {
"self": "<string>",
"accountId": "<string>",
"emailAddress": "<string>",
"avatarUrls": {
"48x48": "<string>",
"24x24": "<string>",
"16x16": "<string>",
"32x32": "<string>"
},
"displayName": "<string>",
"active": true,
"timeZone": "<string>",
"accountType": "<string>"
},
"customfield_10021": null,
"customfield_10044": null,
"aggregateprogress": {
"progress": 1,
"total": 1
},
"priority": {
"self": "<string>",
"iconUrl": "<string>",
"name": "<string>",
"id": "<string>"
},
"labels": [],
"environment": null,
"customfield_10019": "<string>",
"timeestimate": null,
"aggregatetimeoriginalestimate": null,
"versions": [],
"duedate": null,
"progress": {
"progress": 2,
"total": 2
},
"comment": {
"comments": [],
"self": "<string>",
"maxResults": 1,
"total": 1,
"startAt": 0
},
"issuelinks": [],
"votes": {
"self": "<string>",
"votes": 2,
"hasVoted": false
},
"worklog": {
"startAt": 1,
"maxResults": 12,
"total": 2,
"worklogs": []
},
"assignee": {
"self": "<string>",
"accountId": "<string>",
"emailAddress": "<string>",
"avatarUrls": {
"48x48": "<string>",
"24x24": "<string>",
"16x16": "<string>",
"32x32": "<string>"
},
"displayName": "<string>",
"active": true,
"timeZone": "<string>",
"accountType": "<string>"
},
"updated": "2025-03-12T21:01:42.757+0000",
"status": {
"self": "<string>",
"description": "<string>",
"iconUrl": "<string>",
"name": "<string>",
"id": "<string>",
"statusCategory": {
"self": "<string>",
"id": 5,
"key": "<string>",
"colorName": "<string>",
"name": "<string>"
}
}
}
},
{
"expand": "<string>",
"id": "<string>",
"self": "<string>",
"key": "<string>",
"fields": {
"statuscategorychangedate": "2025-03-12T21:01:42.757+0000",
"issuetype": {
"self": "<string>",
"id": "<string>",
"description": "<string>",
"iconUrl": "<string>",
"name": "<string>",
"subtask": false,
"avatarId": 8493,
"entityId": "<string>",
"hierarchyLevel": 0
},
"components": [],
"timespent": null,
"timeoriginalestimate": null,
"project": {
"self": "<string>",
"id": "<string>",
"key": "<string>",
"name": "<string>",
"projectTypeKey": "<string>",
"simplified": true,
"avatarUrls": {
"48x48": "<string>",
"24x24": "<string>",
"16x16": "<string>",
"32x32": "<string>"
}
},
"description": null,
"fixVersions": [],
"statusCategory": {
"self": "<string>",
"id": 4,
"key": "<string>",
"colorName": "<string>",
"name": "<string>"
},
"aggregatetimespent": null,
"resolution": null,
"timetracking": {},
"security": null,
"attachment": [],
"aggregatetimeestimate": null,
"resolutiondate": null,
"workratio": 1,
"summary": "<string>",
"issuerestriction": {
"issuerestrictions": {},
"shouldDisplay": true
},
"watches": {
"self": "<string>",
"watchCount": 2,
"isWatching": true
},
"lastViewed": null,
"creator": {
"self": "<string>",
"accountId": "<string>",
"emailAddress": "<string>",
"avatarUrls": {
"48x48": "<string>",
"24x24": "<string>",
"16x16": "<string>",
"32x32": "<string>"
},
"displayName": "<string>",
"active": true,
"timeZone": "<string>",
"accountType": "<string>"
},
"subtasks": [],
"created": "<string>",
"reporter": {
"self": "<string>",
"accountId": "<string>",
"emailAddress": "<string>",
"avatarUrls": {
"48x48": "<string>",
"24x24": "<string>",
"16x16": "<string>",
"32x32": "<string>"
},
"displayName": "<string>",
"active": true,
"timeZone": "<string>",
"accountType": "<string>"
},
"customfield_10021": null,
"customfield_10044": null,
"aggregateprogress": {
"progress": 0,
"total": 0
},
"priority": {
"self": "<string>",
"iconUrl": "<string>",
"name": "<string>",
"id": "<string>"
},
"labels": [],
"environment": null,
"customfield_10019": "<string>",
"timeestimate": null,
"aggregatetimeoriginalestimate": null,
"versions": [],
"duedate": null,
"progress": {
"progress": 2,
"total": 2
},
"comment": {
"comments": [],
"self": "<string>",
"maxResults": 2,
"total": 1,
"startAt": 2
},
"votes": {
"self": "<string>",
"votes": 2,
"hasVoted": false
},
"issuelinks": [],
"assignee": null,
"worklog": {
"startAt": 1,
"maxResults": 39,
"total": 0,
"worklogs": []
},
"updated": "2025-03-12T21:01:42.757+0000",
"status": {
"self": "<string>",
"description": "<string>",
"iconUrl": "<string>",
"name": "<string>",
"id": "<string>",
"statusCategory": {
"self": "<string>",
"id": 0,
"key": "<string>",
"colorName": "<string>",
"name": "<string>"
}
}
}
}
],
"names": {
"statuscategorychangedate": "2025-03-12T21:01:42.757+0000",
"issuetype": "<string>",
"components": "<string>",
"timespent": "<string>",
"timeoriginalestimate": "<string>",
"project": "<string>",
"description": "<string>",
"fixVersions": "<string>",
"statusCategory": "<string>",
"aggregatetimespent": "<string>",
"resolution": "<string>",
"timetracking": "<string>",
"security": "<string>",
"attachment": "<string>",
"aggregatetimeestimate": "<string>",
"resolutiondate": "2025-03-12T21:01:42.757+0000",
"workratio": "<string>",
"summary": "<string>",
"watches": "<string>",
"issuerestriction": "<string>",
"lastViewed": "<string>",
"creator": "<string>",
"subtasks": "<string>",
"created": "<string>",
"reporter": "<string>",
"customfield_10021": "<string>",
"customfield_10044": "<string>",
"aggregateprogress": "<string>",
"priority": "<string>",
"labels": "<string>",
"environment": "<string>",
"customfield_10019": "<string>",
"timeestimate": "<string>",
"aggregatetimeoriginalestimate": "<string>",
"versions": "<string>",
"duedate": "2025-03-12T21:01:42.757+0000",
"progress": "<string>",
"comment": "<string>",
"issuelinks": "<string>",
"votes": "<string>",
"worklog": "<string>",
"assignee": "<string>",
"updated": "2025-03-12T21:01:42.757+0000",
"status": "<string>"
},
"schema": {
"statuscategorychangedate": {
"type": "<string>",
"system": "<string>"
},
"issuetype": {
"type": "<string>",
"system": "<string>"
},
"components": {
"type": "<string>",
"items": "<string>",
"system": "<string>"
},
"timespent": {
"type": "<string>",
"system": "<string>"
},
"timeoriginalestimate": {
"type": "<string>",
"system": "<string>"
},
"project": {
"type": "<string>",
"system": "<string>"
},
"description": {
"type": "<string>",
"system": "<string>"
},
"fixVersions": {
"type": "<string>",
"items": "<string>",
"system": "<string>"
},
"statusCategory": {
"type": "<string>",
"system": "<string>"
},
"aggregatetimespent": {
"type": "<string>",
"system": "<string>"
},
"resolution": {
"type": "<string>",
"system": "<string>"
},
"timetracking": {
"type": "<string>",
"system": "<string>"
},
"security": {
"type": "<string>",
"system": "<string>"
},
"attachment": {
"type": "<string>",
"items": "<string>",
"system": "<string>"
},
"aggregatetimeestimate": {
"type": "<string>",
"system": "<string>"
},
"resolutiondate": {
"type": "<string>",
"system": "<string>"
},
"workratio": {
"type": "<string>",
"system": "<string>"
},
"summary": {
"type": "<string>",
"system": "<string>"
},
"watches": {
"type": "<string>",
"system": "<string>"
},
"issuerestriction": {
"type": "<string>",
"system": "<string>"
},
"lastViewed": {
"type": "<string>",
"system": "<string>"
},
"creator": {
"type": "<string>",
"system": "<string>"
},
"subtasks": {
"type": "<string>",
"items": "<string>",
"system": "<string>"
},
"created": {
"type": "<string>",
"system": "<string>"
},
"reporter": {
"type": "<string>",
"system": "<string>"
},
"customfield_10021": {
"type": "<string>",
"items": "<string>",
"custom": "<string>",
"customId": 7093
},
"customfield_10044": {
"type": "<string>",
"items": "<string>",
"custom": "<string>",
"customId": 2426
},
"aggregateprogress": {
"type": "<string>",
"system": "<string>"
},
"priority": {
"type": "<string>",
"system": "<string>"
},
"labels": {
"type": "<string>",
"items": "<string>",
"system": "<string>"
},
"environment": {
"type": "<string>",
"system": "<string>"
},
"customfield_10019": {
"type": "<string>",
"custom": "<string>",
"customId": 15087
},
"timeestimate": {
"type": "<string>",
"system": "<string>"
},
"aggregatetimeoriginalestimate": {
"type": "<string>",
"system": "<string>"
},
"versions": {
"type": "<string>",
"items": "<string>",
"system": "<string>"
},
"duedate": {
"type": "<string>",
"system": "<string>"
},
"progress": {
"type": "<string>",
"system": "<string>"
},
"comment": {
"type": "<string>",
"system": "<string>"
},
"issuelinks": {
"type": "<string>",
"items": "<string>",
"system": "<string>"
},
"votes": {
"type": "<string>",
"system": "<string>"
},
"worklog": {
"type": "<string>",
"items": "<string>",
"system": "<string>"
},
"assignee": {
"type": "<string>",
"system": "<string>"
},
"updated": {
"type": "<string>",
"system": "<string>"
},
"status": {
"type": "<string>",
"system": "<string>"
}
},
"nextPageToken": "<string>"
}
Workflow Library Example
List Issues with Jira and Send Results Via Email