IntegrationsJiraActions
Search Jira issues
Search Jira issues with enhanced JQL, explicit fields, and token pagination.
issues.search · Jira · v1
Details
Scopes
read:jira-workoffline_access
Input
| Name | Type | Required | Constraints |
|---|---|---|---|
(root) | object | Yes | additionalProperties false |
jql | string | Yes | minLength 1; maxLength 2000 |
fields | array<string> | No | minItems 1; maxItems 12 |
fields[] | string | Yes | enum summary | status | assignee | reporter | issuetype | project | priority | description | labels | created | updated | parent |
max_results | integer | No | minimum 1; maximum 50 |
next_page_token | string | No | minLength 1; maxLength 512 |
Output
| Name | Type | Required | Constraints |
|---|---|---|---|
(root) | object | Yes | additionalProperties false |
issues | array<object> | Yes | maxItems 50 |
issues[] | object | Yes | additionalProperties false |
issues[].id | string | Yes | minLength 1; maxLength 64 |
issues[].key | string | Yes | minLength 1; maxLength 64 |
issues[].self | string | No | maxLength 2048 |
issues[].summary | string | No | maxLength 255 |
issues[].status | object | No | additionalProperties false |
issues[].status.id | string | No | minLength 1; maxLength 64 |
issues[].status.name | string | No | maxLength 128 |
issues[].status.category_key | string | No | maxLength 64 |
issues[].assignee | object | No | additionalProperties false |
issues[].assignee.account_id | string | No | minLength 1; maxLength 128 |
issues[].assignee.display_name | string | No | maxLength 255 |
issues[].assignee.active | boolean | No | — |
issues[].reporter | object | No | additionalProperties false |
issues[].reporter.account_id | string | No | minLength 1; maxLength 128 |
issues[].reporter.display_name | string | No | maxLength 255 |
issues[].reporter.active | boolean | No | — |
issues[].issuetype | object | No | additionalProperties false |
issues[].issuetype.id | string | No | minLength 1; maxLength 64 |
issues[].issuetype.key | string | No | minLength 1; maxLength 64 |
issues[].issuetype.name | string | No | maxLength 255 |
issues[].project | object | No | additionalProperties false |
issues[].project.id | string | No | minLength 1; maxLength 64 |
issues[].project.key | string | No | minLength 1; maxLength 64 |
issues[].project.name | string | No | maxLength 255 |
issues[].priority | object | No | additionalProperties false |
issues[].priority.id | string | No | minLength 1; maxLength 64 |
issues[].priority.key | string | No | minLength 1; maxLength 64 |
issues[].priority.name | string | No | maxLength 255 |
issues[].labels | array<string> | No | maxItems 50 |
issues[].labels[] | string | Yes | maxLength 255 |
issues[].description | object | No | additionalProperties false |
issues[].description.type | string | Yes | enum doc |
issues[].description.version | integer | Yes | minimum 1; maximum 1 |
issues[].description.content | array<object> | Yes | minItems 1; maxItems 32 |
issues[].description.content[] | object | Yes | additionalProperties false |
issues[].description.content[].type | string | Yes | enum paragraph | heading | bulletList | orderedList |
issues[].description.content[].attrs | object | No | additionalProperties false |
issues[].description.content[].attrs.level | integer | No | minimum 1; maximum 6 |
issues[].description.content[].content | array<object> | No | maxItems 64 |
issues[].description.content[].content[] | object | Yes | additionalProperties false |
issues[].description.content[].content[].type | string | Yes | enum text | hardBreak | listItem | paragraph | heading |
issues[].description.content[].content[].text | string | No | minLength 1; maxLength 2000 |
issues[].description.content[].content[].marks | array<object> | No | maxItems 8 |
issues[].description.content[].content[].marks[] | object | Yes | additionalProperties false |
issues[].description.content[].content[].marks[].type | string | Yes | enum strong | em | code | underline | strike | link |
issues[].description.content[].content[].marks[].attrs | object | No | additionalProperties false |
issues[].description.content[].content[].marks[].attrs.href | string | No | minLength 8; maxLength 2048; pattern ^https://; format uri |
issues[].description.content[].content[].attrs | object | No | additionalProperties false |
issues[].description.content[].content[].attrs.level | integer | No | minimum 1; maximum 6 |
issues[].description.content[].content[].content | array<object> | No | maxItems 64 |
issues[].description.content[].content[].content[] | object | Yes | additionalProperties false |
issues[].description.content[].content[].content[].type | string | Yes | enum text | hardBreak | paragraph | heading |
issues[].description.content[].content[].content[].text | string | No | minLength 1; maxLength 2000 |
issues[].description.content[].content[].content[].marks | array<object> | No | maxItems 8 |
issues[].description.content[].content[].content[].marks[] | object | Yes | additionalProperties false |
issues[].description.content[].content[].content[].marks[].type | string | Yes | enum strong | em | code | underline | strike | link |
issues[].description.content[].content[].content[].marks[].attrs | object | No | additionalProperties false |
issues[].description.content[].content[].content[].marks[].attrs.href | string | No | minLength 8; maxLength 2048; pattern ^https://; format uri |
issues[].description.content[].content[].content[].attrs | object | No | additionalProperties false |
issues[].description.content[].content[].content[].attrs.level | integer | No | minimum 1; maximum 6 |
issues[].description.content[].content[].content[].content | array<object> | No | maxItems 64 |
issues[].description.content[].content[].content[].content[] | object | Yes | additionalProperties false |
issues[].description.content[].content[].content[].content[].type | string | Yes | enum text | hardBreak |
issues[].description.content[].content[].content[].content[].text | string | No | minLength 1; maxLength 2000 |
issues[].description.content[].content[].content[].content[].marks | array<object> | No | maxItems 8 |
issues[].description.content[].content[].content[].content[].marks[] | object | Yes | additionalProperties false |
issues[].description.content[].content[].content[].content[].marks[].type | string | Yes | enum strong | em | code | underline | strike | link |
issues[].description.content[].content[].content[].content[].marks[].attrs | object | No | additionalProperties false |
issues[].description.content[].content[].content[].content[].marks[].attrs.href | string | No | minLength 8; maxLength 2048; pattern ^https://; format uri |
issues[].created | string | No | maxLength 64 |
issues[].updated | string | No | maxLength 64 |
issues[].parent | object | No | additionalProperties false |
issues[].parent.id | string | No | minLength 1; maxLength 64 |
issues[].parent.key | string | No | minLength 1; maxLength 64 |
issues[].parent.name | string | No | maxLength 255 |
next_page_token | string | No | minLength 1; maxLength 512 |
Raw schema
Input
{
"type": "object",
"additionalProperties": false,
"properties": {
"jql": {
"type": "string",
"minLength": 1,
"maxLength": 2000
},
"fields": {
"type": "array",
"items": {
"type": "string",
"enum": [
"summary",
"status",
"assignee",
"reporter",
"issuetype",
"project",
"priority",
"description",
"labels",
"created",
"updated",
"parent"
]
},
"minItems": 1,
"maxItems": 12
},
"max_results": {
"type": "integer",
"minimum": 1,
"maximum": 50
},
"next_page_token": {
"type": "string",
"minLength": 1,
"maxLength": 512
}
},
"required": [
"jql"
]
}Output
{
"type": "object",
"additionalProperties": false,
"properties": {
"issues": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"key": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"self": {
"type": "string",
"maxLength": 2048
},
"summary": {
"type": "string",
"maxLength": 255
},
"status": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"name": {
"type": "string",
"maxLength": 128
},
"category_key": {
"type": "string",
"maxLength": 64
}
}
},
"assignee": {
"type": "object",
"additionalProperties": false,
"properties": {
"account_id": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"display_name": {
"type": "string",
"maxLength": 255
},
"active": {
"type": "boolean"
}
}
},
"reporter": {
"type": "object",
"additionalProperties": false,
"properties": {
"account_id": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"display_name": {
"type": "string",
"maxLength": 255
},
"active": {
"type": "boolean"
}
}
},
"issuetype": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"key": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"name": {
"type": "string",
"maxLength": 255
}
}
},
"project": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"key": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"name": {
"type": "string",
"maxLength": 255
}
}
},
"priority": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"key": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"name": {
"type": "string",
"maxLength": 255
}
}
},
"labels": {
"type": "array",
"items": {
"type": "string",
"maxLength": 255
},
"maxItems": 50
},
"description": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"type": "string",
"enum": [
"doc"
]
},
"version": {
"type": "integer",
"minimum": 1,
"maximum": 1
},
"content": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"type": "string",
"enum": [
"paragraph",
"heading",
"bulletList",
"orderedList"
]
},
"attrs": {
"type": "object",
"additionalProperties": false,
"properties": {
"level": {
"type": "integer",
"minimum": 1,
"maximum": 6
}
}
},
"content": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"type": "string",
"enum": [
"text",
"hardBreak",
"listItem",
"paragraph",
"heading"
]
},
"text": {
"type": "string",
"minLength": 1,
"maxLength": 2000
},
"marks": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"type": "string",
"enum": [
"strong",
"em",
"code",
"underline",
"strike",
"link"
]
},
"attrs": {
"type": "object",
"additionalProperties": false,
"properties": {
"href": {
"type": "string",
"minLength": 8,
"maxLength": 2048,
"pattern": "^https://",
"format": "uri"
}
}
}
},
"required": [
"type"
]
},
"maxItems": 8
},
"attrs": {
"type": "object",
"additionalProperties": false,
"properties": {
"level": {
"type": "integer",
"minimum": 1,
"maximum": 6
}
}
},
"content": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"type": "string",
"enum": [
"text",
"hardBreak",
"paragraph",
"heading"
]
},
"text": {
"type": "string",
"minLength": 1,
"maxLength": 2000
},
"marks": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"type": "string",
"enum": [
"strong",
"em",
"code",
"underline",
"strike",
"link"
]
},
"attrs": {
"type": "object",
"additionalProperties": false,
"properties": {
"href": {
"type": "string",
"minLength": 8,
"maxLength": 2048,
"pattern": "^https://",
"format": "uri"
}
}
}
},
"required": [
"type"
]
},
"maxItems": 8
},
"attrs": {
"type": "object",
"additionalProperties": false,
"properties": {
"level": {
"type": "integer",
"minimum": 1,
"maximum": 6
}
}
},
"content": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"type": "string",
"enum": [
"text",
"hardBreak"
]
},
"text": {
"type": "string",
"minLength": 1,
"maxLength": 2000
},
"marks": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"type": "string",
"enum": [
"strong",
"em",
"code",
"underline",
"strike",
"link"
]
},
"attrs": {
"type": "object",
"additionalProperties": false,
"properties": {
"href": {
"type": "string",
"minLength": 8,
"maxLength": 2048,
"pattern": "^https://",
"format": "uri"
}
}
}
},
"required": [
"type"
]
},
"maxItems": 8
}
},
"required": [
"type"
]
},
"maxItems": 64
}
},
"required": [
"type"
]
},
"maxItems": 64
}
},
"required": [
"type"
]
},
"maxItems": 64
}
},
"required": [
"type"
]
},
"minItems": 1,
"maxItems": 32
}
},
"required": [
"type",
"version",
"content"
]
},
"created": {
"type": "string",
"maxLength": 64
},
"updated": {
"type": "string",
"maxLength": 64
},
"parent": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"key": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"name": {
"type": "string",
"maxLength": 255
}
}
}
},
"required": [
"id",
"key"
]
},
"maxItems": 50
},
"next_page_token": {
"type": "string",
"minLength": 1,
"maxLength": 512
}
},
"required": [
"issues"
]
}