Rate this page:
GET /rest/servicedeskapi/knowledgebase/article
Returns articles which match the given query string across all service desks.
Permissions required: Permission to access the customer portal.
Connect app scope required: READ
read:knowledgebase:jira-service-managementstring
The string used to filter the articles (required).
boolean
If set to true matching query term in the title and excerpt will be highlighted using the {@code @@@hl@@@term@@@endhl@@@} syntax. Default: false.
falseinteger
The starting index of the returned objects. Base index: 0. See the Pagination section for more details.
int32integer
The maximum number of items to return per page. Default: 100. See the Pagination section for more details.
int321 2 3 4
curl --request GET \
--url 'https://your-domain.atlassian.net/rest/servicedeskapi/knowledgebase/article' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json'Returns the articles, on the specified page of the results.
| Content type | Value |
|---|---|
| application/json |
Example response (application/json)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39
{
"_expands": [],
"size": 2,
"start": 2,
"limit": 2,
"isLastPage": false,
"_links": {
"base": "https://your-domain.atlassian.net/rest/servicedeskapi",
"context": "context",
"next": "https://your-domain.atlassian.net/rest/servicedeskapi/knowledgebase/article?start=4&limit=2",
"prev": "https://your-domain.atlassian.net/rest/servicedeskapi/knowledgebase/article?start=0&limit=2"
},
"values": [
{
"title": "Stolen computer",
"excerpt": "assuming your computer was stolen",
"source": {
"type": "confluence",
"pageId": "8786177",
"spaceKey": "IT"
},
"content": {
"iframeSrc": "https://your-domain.atlassian.net/rest/servicedeskapi/knowledgebase/article/view/8786177"
}
},
{
"title": "Upgrading computer",
"excerpt": "each computer older then 3 years can be upgraded",
"source": {
"type": "confluence",
"pageId": "8785228",
"spaceKey": "IT"
},
"content": {
"iframeSrc": "https://your-domain.atlassian.net/rest/servicedeskapi/knowledgebase/article/view/8785228"
}
}
]
}Rate this page: