---
title: "Get all request types"
method: GET
path: "/rest/servicedeskapi/requesttype"
tags: ["Requesttype"]
---

# Get all request types

`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](#api-servicedesk-serviceDeskId-requesttype-get) 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](#permissions) required**: Any

## Query parameters

- `searchQuery` string
- `serviceDeskId` integer[]
- `start` integer
- `limit` integer
- `expand` string[]
- `includeHiddenRequestTypesInSearch` boolean
- `restrictionStatus` string

## Response `200`

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

- PagedDTORequestTypeDTO
  - `_expands` string[]
  - `_links` PagedLinkDTO
    - `base` string, uri — Base URL for the REST API calls.
    - `context` string
    - `next` string, uri — REST API URL for the next page, if there is one.
    - `prev` string, uri — REST API URL for the previous page, if there is one.
    - `self` string, uri — REST API URL for the current page.
  - `isLastPage` boolean — Indicates if this is the last page of records (true) or not (false).
  - `limit` integer — Number of items to be returned per page, up to the maximum set for these objects in the current implementation.
  - `size` integer — Number of items returned in the page.
  - `start` integer — Index of the first item returned in the page.
  - `values` RequestTypeDTO[] — Details of the items included in the page.
    - `_expands` string[] — List of items that can be expanded in the response by specifying the expand query parameter.
    - `_links` SelfLinkDTO
      - `self` string, uri
    - `canCreateRequest` boolean — Whether the user has permission to create a request with this request type.
    - `description` string — Description of the request type.
    - `fields` CustomerRequestCreateMetaDTO
      - `canAddRequestParticipants` boolean — Flag indicating if participants can be added to a request (true) or not.
      - `canRaiseOnBehalfOf` boolean — Flag indicating if a request can be raised on behalf of another user (true) or not.
      - `requestTypeFields` RequestTypeFieldDTO[] — List of the fields included in this request.
        - `defaultValues` RequestTypeFieldValueDTO[] — List of default values for the field.
          - `children` RequestTypeFieldValueDTO[] — List of child fields.
          - `label` string — Label for the field.
          - `value` string — Value of the field.
        - `description` string — Description of the field.
        - `fieldId` string — ID of the field.
        - `jiraSchema` JsonTypeBean — The schema of a field.
          - `configuration` object — If the field is a custom field, the configuration of the field.
          - `custom` string — If the field is a custom field, the URI of the field.
          - `customId` integer — If the field is a custom field, the custom ID of the field.
          - `items` string — When the data type is an array, the name of the field items within the array.
          - `system` string — If the field is a system field, the name of the field.
          - `type` string, required — The data type of the field.
        - `name` string — Name of the field.
        - `presetValues` string[] — List of preset values for the field.
        - `required` boolean — Indicates if the field is required (true) or not (false).
        - `validValues` RequestTypeFieldValueDTO[] — List of valid values for the field.
          - `children` RequestTypeFieldValueDTO[] — List of child fields.
          - `label` string — Label for the field.
          - `value` string — Value of the field.
        - `visible` boolean
    - `groupIds` string[] — List of the request type groups the request type belongs to.
    - `helpText` string — Help text for the request type.
    - `icon` RequestTypeIconDTO
      - `_links` RequestTypeIconLinkDTO
        - `iconUrls` object — URLs for the request type icons.
      - `id` string — ID of the request type icon.
    - `id` string — ID for the request type.
    - `issueTypeId` string — ID of the issue type the request type is based upon.
    - `name` string — Short name for the request type.
    - `portalId` string — ID of the customer portal associated with the service desk project.
    - `practice` string — The request type's practice
    - `restrictionStatus` 'OPEN' | 'RESTRICTED' — Whether request type is restricted or not.
    - `serviceDeskId` string — ID of the service desk the request type belongs to.

## Other responses

- `401` — Returned if the user is not logged in.
- `500` — Internal Server Error.

---

[API](https://skmtc.net/atlassian/apis/service-management-public-rest-api.md) · [All operations](https://skmtc.net/atlassian/apis/service-management-public-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/atlassian/service-management-public-rest-api/versions/d1dc1a13b783/schema)