v2
OpenAPI 3.0.12026-08-0174115357.9 KBGet request types
This method returns all customer request types from a service desk. There are two parameters for filtering the returned list:
- groupId which filters the results to items in the customer request type group.
- searchQuery which is matched against request types' name or description. For example, the strings "Install", "Inst", "Equi", or "Equipment" will match a 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: Permission to access the service desk.
Path parameters
The ID of the service desk whose customer request types are to be returned. This can alternatively be a project identifier.
Query parameters
Filters results to those in a customer request type group.
The string to be used to filter the results.
The starting index of the returned objects. Base index: 0. See the Pagination section for more details.
The maximum number of items to return per page. Default: 50. See the Pagination section for more details.
Whether to include hidden request types when searching with searchQuery.
Request type restriction status (open or restricted) used to filter the results.
Response
Returns the requested customer request types, on the specified page of the results.