Rate this page:
GET /rest/servicedeskapi/requesttype
This method returns all customer request types used in the Jira Service Management instance, optionally filtered by a query string.
Use servicedeskapi/servicedesk/{serviceDeskId}/requesttype to find the customer request types supported by a specific service desk.
The returned list of customer request types can be filtered using the query
parameter. The parameter is matched against the customer request types' name
or description
. For example, searching for "Install", "Inst", "Equi", or "Equipment" will match a customer request type with the name "Equipment Installation Request".
Permissions required: Any
Connect app scope required: READ
read:servicedesk-request
read:requesttype:jira-service-management
string
String to be used to filter the results.
Array<integer>
Filter the request types by service desk Ids provided. Multiple values of the query parameter are supported. For example, serviceDeskId=1&serviceDeskId=2
will return request types only for service desks 1 and 2.
integer
The starting index of the returned objects. Base index: 0. See the Pagination section for more details.
int32
integer
The maximum number of items to return per page. Default: 100. See the Pagination section for more details.
int32
Array<string>
1 2 3 4
curl --request GET \
--url 'https://your-domain.atlassian.net/rest/servicedeskapi/requesttype' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json'
Returns the request types, 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 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95
{
"_expands": [],
"size": 3,
"start": 3,
"limit": 3,
"isLastPage": false,
"_links": {
"base": "https://your-domain.atlassian.net/rest/servicedeskapi",
"context": "context",
"next": "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/28/requesttype?start=6&limit=3",
"prev": "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/28/requesttype?start=0&limit=3"
},
"values": [
{
"_expands": [],
"id": "11001",
"_links": {
"self": "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/28/requesttype/11001"
},
"name": "Get IT Help",
"description": "Get IT Help",
"helpText": "Please tell us clearly the problem you have within 100 words.",
"issueTypeId": "12345",
"serviceDeskId": "28",
"portalId": "2",
"groupIds": [
"12"
],
"icon": {
"id": "12345",
"_links": {
"iconUrls": {
"48x48": "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12345?size=large",
"24x24": "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12345?size=small",
"16x16": "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12345?size=xsmall",
"32x32": "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12345?size=medium"
}
}
}
},
{
"_expands": [],
"id": "11002",
"_links": {
"self": "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/28/requesttype/11002"
},
"name": "Request a new account",
"description": "Request a new account",
"issueTypeId": "12345",
"serviceDeskId": "28",
"portalId": "2",
"groupIds": [
"13",
"14"
],
"icon": {
"id": "12346",
"_links": {
"iconUrls": {
"48x48": "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12346?size=large",
"24x24": "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12346?size=small",
"16x16": "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12346?size=xsmall",
"32x32": "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12346?size=medium"
}
}
}
},
{
"_expands": [],
"id": "11003",
"_links": {
"self": "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/28/requesttype/11003"
},
"name": "Hardware request",
"description": "Request a hardware support",
"issueTypeId": "12345",
"serviceDeskId": "28",
"portalId": "2",
"groupIds": [
"13"
],
"icon": {
"id": "12347",
"_links": {
"iconUrls": {
"48x48": "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12347?size=large",
"24x24": "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12347?size=small",
"16x16": "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12347?size=xsmall",
"32x32": "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12347?size=medium"
}
}
}
}
]
}
Rate this page: