--- title: "Get customer requests" method: GET path: "/rest/servicedeskapi/request" tags: ["Request"] --- # Get customer requests `GET /rest/servicedeskapi/request` This method returns all customer requests for the user executing the query. The returned customer requests are ordered chronologically by the latest activity on each request. For example, the latest status transition or comment. **[Permissions](#permissions) required**: Permission to access the specified service desk. **Response limitations**: For customers, the list returned will include request they created (or were created on their behalf) or are participating in only. ## Query parameters - `searchTerm` string - `requestOwnership` string[] - `requestStatus` string - `approvalStatus` string - `organizationId` integer - `serviceDeskId` integer - `requestTypeId` integer - `expand` string[] - `start` integer - `limit` integer ## Response `200` Returns the customer requests, on the specified page of the results. - PagedDTOCustomerRequestDTO - `_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` CustomerRequestDTO[] — 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` CustomerRequestLinkDTO - `agent` string, uri — Jira agent view URL for the request. - `jiraRest` string, uri — REST API URL for the request. - `self` string, uri - `web` string, uri — Web URL for the request. - `actions` CustomerRequestActionsDTO - `addAttachment` CustomerRequestActionDTO - `allowed` boolean — Indicates whether the user can undertake the action (true) or not (false). - `addComment` CustomerRequestActionDTO - `allowed` boolean — Indicates whether the user can undertake the action (true) or not (false). - `addParticipant` CustomerRequestActionDTO - `allowed` boolean — Indicates whether the user can undertake the action (true) or not (false). - `removeParticipant` CustomerRequestActionDTO - `allowed` boolean — Indicates whether the user can undertake the action (true) or not (false). - `attachments` PagedDTOAttachmentDTO - `_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` AttachmentDTO[] — Details of the items included in the page. - `_links` AttachmentLinkDTO - `content` string, uri — URL for the attachment. - `jiraRest` string, uri — REST API URL for the attachment - `self` string, uri - `thumbnail` string, uri — URL for the attachment's thumbnail image. - `author` UserDTO - `_links` UserLinkDTO - `avatarUrls` object — Links to the various sizes of the customer's avatar. Note that this property is deprecated, and will be removed in future versions. - `jiraRest` string, uri — REST API URL for the customer. - `self` string, uri - `accountId` string — The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. - `active` boolean — Indicates if the customer is active (true) or inactive (false) - `displayName` string — Customer's name for display in a UI. Depending on the customer’s privacy settings, this may return an alternative value. - `emailAddress` string — Customer's email address. Depending on the customer’s privacy settings, this may be returned as null. - `key` string — This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. - `name` string — This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. - `timeZone` string — Customer time zone. Depending on the customer’s privacy settings, this may be returned as null. - `created` DateDTO - `epochMillis` integer — Date as the number of milliseconds that have elapsed since 00:00:00 Coordinated Universal Time (UTC), 1 January 1970. - `friendly` string — Date in a user-friendly text format. - `iso8601` string — Date in ISO8601 format. - `jira` string — Date in the format used in the Jira REST APIs, which is ISO8601 format but extended with milliseconds. For example, 2016-09-28T23:08:32.097+1000. - `filename` string — Filename of the item attached. - `mimeType` string — MIME type of the attachment. - `size` integer — Size of the attachment in bytes. - `comments` PagedDTOCommentDTO - `_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` CommentDTO[] — 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 - `attachments` PagedDTOAttachmentDTO - `_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` AttachmentDTO[] — Details of the items included in the page. - `_links` AttachmentLinkDTO - … - `author` UserDTO - … - `created` DateDTO - … - `filename` string — Filename of the item attached. - `mimeType` string — MIME type of the attachment. - `size` integer — Size of the attachment in bytes. - `author` UserDTO - `_links` UserLinkDTO - `avatarUrls` object — Links to the various sizes of the customer's avatar. Note that this property is deprecated, and will be removed in future versions. - `jiraRest` string, uri — REST API URL for the customer. - `self` string, uri - `accountId` string — The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. - `active` boolean — Indicates if the customer is active (true) or inactive (false) - `displayName` string — Customer's name for display in a UI. Depending on the customer’s privacy settings, this may return an alternative value. - `emailAddress` string — Customer's email address. Depending on the customer’s privacy settings, this may be returned as null. - `key` string — This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. - `name` string — This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. - `timeZone` string — Customer time zone. Depending on the customer’s privacy settings, this may be returned as null. - `body` string — Content of the comment. - `created` DateDTO - `epochMillis` integer — Date as the number of milliseconds that have elapsed since 00:00:00 Coordinated Universal Time (UTC), 1 January 1970. - `friendly` string — Date in a user-friendly text format. - `iso8601` string — Date in ISO8601 format. - `jira` string — Date in the format used in the Jira REST APIs, which is ISO8601 format but extended with milliseconds. For example, 2016-09-28T23:08:32.097+1000. - `id` string — ID of the comment. - `public` boolean — Indicates whether the comment is public (true) or private/internal (false). - `renderedBody` RenderedValueDTO - `html` string - `createdDate` DateDTO - `epochMillis` integer — Date as the number of milliseconds that have elapsed since 00:00:00 Coordinated Universal Time (UTC), 1 January 1970. - `friendly` string — Date in a user-friendly text format. - `iso8601` string — Date in ISO8601 format. - `jira` string — Date in the format used in the Jira REST APIs, which is ISO8601 format but extended with milliseconds. For example, 2016-09-28T23:08:32.097+1000. - `currentStatus` CustomerRequestStatusDTO - `status` string — Name of the status condition. - `statusCategory` 'UNDEFINED' | 'NEW' | 'INDETERMINATE' | 'DONE' — Status category the status belongs to. - `statusDate` DateDTO - `epochMillis` integer — Date as the number of milliseconds that have elapsed since 00:00:00 Coordinated Universal Time (UTC), 1 January 1970. - `friendly` string — Date in a user-friendly text format. - `iso8601` string — Date in ISO8601 format. - `jira` string — Date in the format used in the Jira REST APIs, which is ISO8601 format but extended with milliseconds. For example, 2016-09-28T23:08:32.097+1000. - `issueId` string — ID of the request, as the peer issue ID. - `issueKey` string — Key of the request, as the peer issue key. - `participants` PagedDTOUserDTO - `_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` UserDTO[] — Details of the items included in the page. - `_links` UserLinkDTO - `avatarUrls` object — Links to the various sizes of the customer's avatar. Note that this property is deprecated, and will be removed in future versions. - `jiraRest` string, uri — REST API URL for the customer. - `self` string, uri - `accountId` string — The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. - `active` boolean — Indicates if the customer is active (true) or inactive (false) - `displayName` string — Customer's name for display in a UI. Depending on the customer’s privacy settings, this may return an alternative value. - `emailAddress` string — Customer's email address. Depending on the customer’s privacy settings, this may be returned as null. - `key` string — This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. - `name` string — This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. - `timeZone` string — Customer time zone. Depending on the customer’s privacy settings, this may be returned as null. - `reporter` UserDTO - `_links` UserLinkDTO - `avatarUrls` object — Links to the various sizes of the customer's avatar. Note that this property is deprecated, and will be removed in future versions. - `jiraRest` string, uri — REST API URL for the customer. - `self` string, uri - `accountId` string — The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. - `active` boolean — Indicates if the customer is active (true) or inactive (false) - `displayName` string — Customer's name for display in a UI. Depending on the customer’s privacy settings, this may return an alternative value. - `emailAddress` string — Customer's email address. Depending on the customer’s privacy settings, this may be returned as null. - `key` string — This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. - `name` string — This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. - `timeZone` string — Customer time zone. Depending on the customer’s privacy settings, this may be returned as null. - `requestFieldValues` CustomerRequestFieldValueDTO[] — JSON map of Jira field IDs and their values representing the content of the request. This list does not include hidden fields. - `fieldId` string — ID of the field. - `label` string — Text label for the field. - `renderedValue` object — Value of the field rendered in the UI. - `value` unknown - `requestType` RequestTypeDTO - `_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. - `requestTypeId` string — ID of the request type for the request. - `serviceDesk` ServiceDeskDTO - `_links` SelfLinkDTO - `self` string, uri - `id` string — ID of the service desk. - `projectId` string — ID of the peer project for the service desk. - `projectKey` string — Key of the peer project of the service desk. - `projectName` string — Name of the project and service desk. - `projectTypeKey` string — Key of the project type. - `serviceDeskId` string — ID of the service desk the request belongs to. - `sla` PagedDTOSlaInformationDTO - `_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` SlaInformationDTO[] — Details of the items included in the page. - `_links` SelfLinkDTO - `self` string, uri - `completedCycles` SlaInformationCompletedCycleDTO[] — List of completed cycles for the SLA. - `breachTime` DateDTO - `epochMillis` integer — Date as the number of milliseconds that have elapsed since 00:00:00 Coordinated Universal Time (UTC), 1 January 1970. - `friendly` string — Date in a user-friendly text format. - `iso8601` string — Date in ISO8601 format. - `jira` string — Date in the format used in the Jira REST APIs, which is ISO8601 format but extended with milliseconds. For example, 2016-09-28T23:08:32.097+1000. - `breached` boolean — Indicates if the SLA (duration) was exceeded (true) or not (false). - `elapsedTime` DurationDTO - `friendly` string — Duration in a user-friendly text format. - `millis` integer — Duration in milliseconds. - `goalDuration` DurationDTO - `friendly` string — Duration in a user-friendly text format. - `millis` integer — Duration in milliseconds. - `remainingTime` DurationDTO - `friendly` string — Duration in a user-friendly text format. - `millis` integer — Duration in milliseconds. - `startTime` DateDTO - `epochMillis` integer — Date as the number of milliseconds that have elapsed since 00:00:00 Coordinated Universal Time (UTC), 1 January 1970. - `friendly` string — Date in a user-friendly text format. - `iso8601` string — Date in ISO8601 format. - `jira` string — Date in the format used in the Jira REST APIs, which is ISO8601 format but extended with milliseconds. For example, 2016-09-28T23:08:32.097+1000. - `stopTime` DateDTO - `epochMillis` integer — Date as the number of milliseconds that have elapsed since 00:00:00 Coordinated Universal Time (UTC), 1 January 1970. - `friendly` string — Date in a user-friendly text format. - `iso8601` string — Date in ISO8601 format. - `jira` string — Date in the format used in the Jira REST APIs, which is ISO8601 format but extended with milliseconds. For example, 2016-09-28T23:08:32.097+1000. - `id` string — ID of the Service Level Agreement (SLA). - `name` string — Description of the SLA. - `ongoingCycle` SlaInformationOngoingCycleDTO - `breachTime` DateDTO - `epochMillis` integer — Date as the number of milliseconds that have elapsed since 00:00:00 Coordinated Universal Time (UTC), 1 January 1970. - `friendly` string — Date in a user-friendly text format. - `iso8601` string — Date in ISO8601 format. - `jira` string — Date in the format used in the Jira REST APIs, which is ISO8601 format but extended with milliseconds. For example, 2016-09-28T23:08:32.097+1000. - `breached` boolean — Indicates whether the SLA has been breached (true) or not (false). - `elapsedTime` DurationDTO - `friendly` string — Duration in a user-friendly text format. - `millis` integer — Duration in milliseconds. - `goalDuration` DurationDTO - `friendly` string — Duration in a user-friendly text format. - `millis` integer — Duration in milliseconds. - `paused` boolean — Indicates whether the SLA is paused (true) or not (false). - `remainingTime` DurationDTO - `friendly` string — Duration in a user-friendly text format. - `millis` integer — Duration in milliseconds. - `startTime` DateDTO - `epochMillis` integer — Date as the number of milliseconds that have elapsed since 00:00:00 Coordinated Universal Time (UTC), 1 January 1970. - `friendly` string — Date in a user-friendly text format. - `iso8601` string — Date in ISO8601 format. - `jira` string — Date in the format used in the Jira REST APIs, which is ISO8601 format but extended with milliseconds. For example, 2016-09-28T23:08:32.097+1000. - `withinCalendarHours` boolean — Indicates whether the SLA it timed during calendared working hours only (true) or not (false). - `slaDisplayFormat` string — Format in which SLA is to be displayed in the UI - `status` PagedDTOCustomerRequestStatusDTO - `_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` CustomerRequestStatusDTO[] — Details of the items included in the page. - `status` string — Name of the status condition. - `statusCategory` 'UNDEFINED' | 'NEW' | 'INDETERMINATE' | 'DONE' — Status category the status belongs to. - `statusDate` DateDTO - `epochMillis` integer — Date as the number of milliseconds that have elapsed since 00:00:00 Coordinated Universal Time (UTC), 1 January 1970. - `friendly` string — Date in a user-friendly text format. - `iso8601` string — Date in ISO8601 format. - `jira` string — Date in the format used in the Jira REST APIs, which is ISO8601 format but extended with milliseconds. For example, 2016-09-28T23:08:32.097+1000. - `summary` string — Summary of the request created ## Other responses - `401` — Returned if the user is not logged in. - `404` — Returned if the user does not have permission to access the service desk, the service desk does not exist, or the service desk does not support the request type. - `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)