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:servicedesk-requestread:knowledgebase:jira-service-managementstring
Requiredboolean
Requiredinteger
integer
Returns the articles, on the specified page of the results.
1
2
3
4
curl --request GET \
--url 'https://your-domain.atlassian.net/rest/servicedeskapi/knowledgebase/article?query={query}&highlight={highlight}' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: 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: