ATatlassian
Requesttype

Get all request types

Changed on

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 searchQuery 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".

Note: This API by default will filter out request types hidden in the portal (i.e. request types without groups and request types where a user doesn't have permission) when searchQuery is provided, unless includeHiddenRequestTypesInSearch is set to true. Restricted request types will not be returned for those who aren't admins.

Permissions required: Any

get/rest/servicedeskapi/requesttype

Request

  • Base URL
    https://your-domain.atlassian.net
  • URL
    https://your-domain.atlassian.net/rest/servicedeskapi/requesttype
  • Auth
    OAuth 2
    Authorization code: https://auth.atlassian.com/authorize
    Token URL: https://auth.atlassian.com/oauth/token scopes: read:servicedesk-request

Query parameters

searchQuerystring

String to be used to filter the results.

serviceDeskIdinteger[]

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.

startinteger

The starting index of the returned objects. Base index: 0. See the Pagination section for more details.

limitinteger

The maximum number of items to return per page. Default: 50. See the Pagination section for more details.

expandstring[]
includeHiddenRequestTypesInSearchboolean

Whether to include hidden request types when searching with searchQuery.

restrictionStatusstring

Request type restriction status (open or restricted) used to filter the results.

Response

Returns the request types, on the specified page of the results.

_expandsstring[]
isLastPageboolean

Indicates if this is the last page of records (true) or not (false).

limitinteger

Number of items to be returned per page, up to the maximum set for these objects in the current implementation.

sizeinteger

Number of items returned in the page.

startinteger

Index of the first item returned in the page.

Changes

  • bba7b3477d98Revision changes
    • info

      added the new optional query request parameter includeHiddenRequestTypesInSearch

    • info

      added the new optional query request parameter restrictionStatus

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status