---
updatedAt: 2026-05-27T12:51:18.000Z
agentTools:
  projectIndex: https://developer.onetrust.com/onetrust/llms.txt
---

# Get Request

Use this API to retrieve a single request by its unique identifier along with the associated approver details, date created, and data subject's first and last name.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Privacy Automation - Data Subject Request (DSR) Automation",
    "version": "1.0",
    "contact": {
      "name": "OneTrust Support",
      "url": "https://my.onetrust.com/s/contactsupport"
    },
    "license": {
      "name": "Apache 2.0",
      "url": "https://www.apache.org/licenses/LICENSE-2.0"
    },
    "description": "The Privacy Rights Automation are used to manage, process, and fulfill data subject access requests (DSARs), including request creation, subtask management, resolution codes, verification methods, and audit history."
  },
  "servers": [
    {
      "url": "https://{hostname}",
      "variables": {
        "hostname": {
          "default": "hostname",
          "description": "The OneTrust hostname such as app.onetrust.com, app-eu.onetrust.com, app-de.onetrust.com, app-uk.onetrust.com, app-apac.onetrust.com, trial.onetrust.com, or uat.onetrust.com."
        }
      }
    }
  ],
  "tags": [
    {
      "name": "Request Queues",
      "description": "APIs used to create, search, update, and manage privacy request queues.",
      "externalDocs": {
        "description": "OpenAPI 3.1.0 - Download Definition",
        "url": "https://developer.onetrust.com/onetrust/openapi/privacy-automation-data-subject-request-dsr-automation.json"
      },
      "x-displayName": "Request Queues"
    }
  ],
  "paths": {
    "/api/datasubject/v2/requestqueues/{requestQueueRefId}/language/{language}": {
      "get": {
        "operationId": "getRequestByIdUsingGET",
        "summary": "Get Request",
        "description": "Use this API to retrieve a single request by its unique identifier along with the associated approver details, date created, and data subject's first and last name.",
        "tags": [
          "Request Queues"
        ],
        "x-onetrust": {
          "spec-label": "https://developer.onetrust.com/onetrust/openapi/privacy-automation-data-subject-request-dsr-automation.json"
        },
        "parameters": [
          {
            "name": "requestQueueRefId",
            "in": "path",
            "required": true,
            "schema": {
              "description": "Reference ID of the request",
              "type": "string"
            },
            "example": "A1B2C3D46E"
          },
          {
            "name": "language",
            "in": "path",
            "required": true,
            "schema": {
              "description": "A language code that identifies the language in which the request data should be returned, assuming translations are available for that language. \nExamples: en-us for English, de for German, fr for French, etc.",
              "type": "string"
            },
            "example": "en-us"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PrivacyAutomation-DataSubjectRequestDSRAutomation_RequestByIdV2Dto"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request"
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "Forbidden"
          },
          "429": {
            "description": "Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).",
            "headers": {
              "Retry-After": {
                "schema": {
                  "description": "The number of seconds after which requests will be allowed again.",
                  "format": "int32"
                }
              },
              "ot-period": {
                "schema": {
                  "description": "The unit of time for which the rate limit applies",
                  "enum": [
                    "HOUR",
                    "MINUTE"
                  ]
                }
              },
              "ot-ratelimit-event-id": {
                "schema": {
                  "description": "The unique identifier for the rate-limiting event.",
                  "format": "uuid"
                }
              },
              "ot-request-made": {
                "schema": {
                  "description": "The number of requests made within the specified period.",
                  "format": "int32"
                }
              },
              "ot-requests-allowed": {
                "schema": {
                  "description": "The number of requests allowed within the specified period.",
                  "format": "int32"
                }
              }
            }
          },
          "500": {
            "description": "Internal Server Error"
          }
        },
        "security": [
          {
            "PrivacyAutomation-DataSubjectRequestDSRAutomation_OAUTH2": [
              "DSAR",
              "DSAR_READ",
              "DSAR_WRITE"
            ]
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "PrivacyAutomation-DataSubjectRequestDSRAutomation_RequestQueueListDto": {
        "type": "object",
        "properties": {
          "firstName": {
            "type": "string"
          },
          "lastName": {
            "type": "string"
          },
          "email": {
            "type": "string"
          },
          "requestQueueId": {
            "type": "string",
            "format": "uuid"
          },
          "requestQueueRefId": {
            "type": "string"
          },
          "orgGroupId": {
            "type": "string",
            "format": "uuid"
          },
          "daysLeft": {
            "type": "integer",
            "format": "int32"
          },
          "status": {
            "type": "integer",
            "format": "int64"
          },
          "dateCreated": {
            "type": "string",
            "format": "date-time"
          },
          "isExtended": {
            "type": "boolean"
          },
          "reviewer": {
            "type": "string"
          },
          "reviewerId": {
            "type": "string",
            "format": "uuid"
          },
          "language": {
            "type": "string"
          },
          "templateId": {
            "type": "string",
            "format": "uuid"
          },
          "currentStage": {
            "type": "string"
          },
          "requestTypes": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "subjectTypes": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "deadline": {
            "type": "string",
            "format": "date-time"
          },
          "workflowDetailDto": {
            "$ref": "#/components/schemas/PrivacyAutomation-DataSubjectRequestDSRAutomation_RequestQueueWorkflowDetailDto"
          },
          "totalSubtasks": {
            "type": "integer",
            "format": "int64"
          },
          "completedSubtasks": {
            "type": "integer",
            "format": "int64"
          },
          "remainingSubtasks": {
            "type": "integer",
            "format": "int64"
          },
          "dsLanguageName": {
            "type": "string"
          },
          "webformName": {
            "type": "string"
          },
          "workflowName": {
            "type": "string"
          },
          "workflowReferenceId": {
            "type": "string",
            "format": "uuid"
          },
          "resolution": {
            "type": "string"
          },
          "lastUpdated": {
            "type": "string",
            "format": "date-time"
          },
          "authEnabled": {
            "type": "boolean"
          },
          "lastPublicCommentDate": {
            "type": "string",
            "format": "date-time"
          },
          "lastDSReplyDate": {
            "type": "string",
            "format": "date-time"
          },
          "state": {
            "type": "string"
          },
          "country": {
            "type": "string"
          },
          "closureDate": {
            "type": "string",
            "format": "date-time"
          },
          "countryCode": {
            "type": "string"
          },
          "webFormVersion": {
            "type": "integer",
            "format": "int64"
          },
          "remainingDaysForMaxDeadline": {
            "type": "integer",
            "format": "int32"
          },
          "numberOfLinkedRequests": {
            "type": "integer",
            "format": "int32"
          },
          "maxDeadlineExtensionDate": {
            "type": "string",
            "format": "date-time"
          },
          "selectFields": {
            "type": "object",
            "additionalProperties": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "properties": {
              "all": {
                "type": "object",
                "additionalProperties": {
                  "type": "string"
                },
                "writeOnly": true
              },
              "empty": {
                "type": "boolean"
              }
            }
          },
          "inputFields": {
            "type": "object",
            "additionalProperties": {
              "type": "string"
            }
          },
          "totalDataCount": {
            "type": "integer",
            "format": "int32"
          },
          "retentionStatus": {
            "type": "integer",
            "format": "int32"
          },
          "resultsSummaryDataCount": {
            "$ref": "#/components/schemas/PrivacyAutomation-DataSubjectRequestDSRAutomation_ResultsSummaryDataCountDto"
          },
          "slaExceeded": {
            "type": "string"
          },
          "visited": {
            "type": "boolean"
          },
          "attentionRequired": {
            "type": "boolean"
          },
          "seededOtherData": {
            "type": "object",
            "additionalProperties": {
              "type": "string"
            }
          },
          "lastDsAccessDate": {
            "type": "string",
            "format": "date-time"
          },
          "assignedTogroup": {
            "type": "boolean"
          },
          "additionalStatuses": {
            "type": "string",
            "enum": [
              "0",
              "10"
            ]
          },
          "daysPaused": {
            "type": "number",
            "format": "double"
          },
          "dsAccessRevoked": {
            "type": "boolean"
          },
          "testRequest": {
            "type": "boolean"
          },
          "taskMode": {
            "type": "boolean"
          }
        }
      },
      "PrivacyAutomation-DataSubjectRequestDSRAutomation_RequestQueueWorkflowDetailDto": {
        "type": "object",
        "properties": {
          "stage": {
            "type": "string"
          },
          "allowRequestQueueUpdate": {
            "type": "boolean"
          },
          "beginDeadlineCalc": {
            "type": "boolean"
          },
          "allowDeadlineEdit": {
            "type": "boolean"
          }
        }
      },
      "PrivacyAutomation-DataSubjectRequestDSRAutomation_ResultsSummaryDataCountDto": {
        "type": "object",
        "properties": {
          "dataPoints": {
            "type": "integer",
            "format": "int32"
          },
          "unstructuredData": {
            "type": "integer",
            "format": "int32"
          },
          "attachments": {
            "type": "integer",
            "format": "int32"
          },
          "excluded": {
            "type": "integer",
            "format": "int32"
          }
        }
      },
      "PrivacyAutomation-DataSubjectRequestDSRAutomation_RequestByIdV2Dto": {
        "type": "object",
        "properties": {
          "requestQueueRefId": {
            "description": "Reference ID of the request. This is a 10-character ID that is unique to each request.",
            "type": "string",
            "example": "SL244HWD6D"
          },
          "requestQueueId": {
            "description": "The request GUID",
            "type": "string",
            "format": "uuid",
            "example": "e2d0f59e-3df0-4b1f-965d-d57547ed44ad"
          },
          "firstName": {
            "description": "First name of the data subject.",
            "type": "string",
            "example": "Jonny"
          },
          "lastName": {
            "description": "Last name of the data subject.",
            "type": "string",
            "example": "Sardar"
          },
          "organization": {
            "description": "Organization to which this request is assigned.",
            "type": "string",
            "example": "my own org"
          },
          "status": {
            "description": "Current stage of the request. Various stages in the order of progression are: New, Verifying identity, In progress, Rejected, Complete.",
            "type": "string",
            "example": "NEW"
          },
          "requestTypes": {
            "description": "Request types selected while submitting the request.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "example": [
              "Data Portability, Update Data"
            ]
          },
          "deadline": {
            "description": "Deadline for the request.",
            "type": "string",
            "format": "date-time",
            "example": "2019-09-08T12:49:47.920Z"
          },
          "isExtended": {
            "description": "Returns true if the request complete time is being extended.",
            "type": "boolean",
            "example": false
          },
          "dateCreated": {
            "description": "Date on which request is submitted.",
            "type": "string",
            "format": "date-time",
            "example": "2019-08-09T12:49:47.983Z"
          },
          "dateUpdated": {
            "description": "Last activity date on the request.",
            "type": "string",
            "format": "date-time",
            "example": "2019-09-25T06:50:15.470Z"
          },
          "subjectTypes": {
            "description": "Subject types selected while submitting the request. Subject type can be: Prospective Employee, Student, Customer, Contractor, Employee, Patient.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "example": [
              "Student"
            ]
          },
          "approver": {
            "description": "Approver or assignee for the request.",
            "type": "string",
            "example": "Jonny Sardar Sadmin"
          },
          "language": {
            "description": "Language in which the request is created.",
            "type": "string",
            "example": "en-us"
          },
          "countryCode": {
            "description": "The code for the country as per ISO 3166. e.g. US for the United States, DE for Germany.",
            "type": "string",
            "example": "DZ"
          },
          "countryName": {
            "description": "Name of the country.",
            "type": "string",
            "example": "Algeria"
          },
          "email": {
            "description": "Email provided while submitting the request.",
            "type": "string",
            "example": "abcd@gmail.com"
          },
          "workflow": {
            "description": "Name of the request workflow.",
            "type": "string",
            "example": "Default Workflow"
          },
          "webform": {
            "description": "Name of the webform.",
            "type": "string",
            "example": "!! Nikki"
          },
          "dateCompleted": {
            "description": "Date on which the request is completed.",
            "type": "string",
            "format": "date-time",
            "example": "2019-05-31T12:43:24.173Z"
          },
          "resolution": {
            "description": "Resolution selected if the request is rejected.",
            "type": "string",
            "example": "Not a privacy-related request"
          },
          "remainingDaysForMaxDeadline": {
            "description": "Legal Deadline + Maximum Number of Extension Days based on country of request + Total Pause days.",
            "type": "integer",
            "format": "int32",
            "example": 30
          },
          "maxDeadlineExtensionDate": {
            "description": "Legal Deadline + Maximum Number of Extension Days based on country of request + Total Pause days.",
            "type": "string",
            "format": "date-time",
            "example": "2023-09-08T12:49:47.920Z"
          },
          "assignedToGroup": {
            "description": "Indicates if the request reviewer is assigned to a usergroup or not.",
            "type": "boolean",
            "example": false
          },
          "additionalStatuses": {
            "description": "Status of the request timer, such as PAUSED or ACTIVE.",
            "type": "string",
            "example": "PAUSED",
            "enum": [
              "0",
              "10"
            ]
          },
          "daysToRespond": {
            "description": "Number of days to respond to the request.",
            "type": "integer",
            "format": "int32",
            "example": 3
          },
          "hoursWorked": {
            "description": "Number of hours worked.",
            "type": "number",
            "format": "double",
            "example": 40
          },
          "workflowID": {
            "description": "ID of the workflow associated with the request.",
            "type": "string",
            "format": "uuid"
          },
          "totalCost": {
            "description": "Total cost associated with the request.",
            "type": "string"
          },
          "additionalData": {
            "description": "Both \"additionalData\" and \"requestAdditionalData\" hold identical information. Opt for \"requestAdditionalData\" for improved parsing and to prevent issues related to Unicode characters.",
            "type": "string"
          },
          "requestV2CommentDtos": {
            "description": "List of comments associated with the request.",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PrivacyAutomation-DataSubjectRequestDSRAutomation_RequestV2CommentDto"
            }
          },
          "multiselectFields": {
            "description": "Map of multi-select field values.",
            "type": "object",
            "additionalProperties": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          "approverEmail": {
            "description": "Approver or assignee's email.",
            "type": "string",
            "example": "js@onetrust.com"
          },
          "legalDeadLineInfo": {
            "$ref": "#/components/schemas/PrivacyAutomation-DataSubjectRequestDSRAutomation_RequestQueueListDto",
            "writeOnly": true
          },
          "requestAdditionalData": {
            "description": "The \"requestAdditionalData\" can include both the fields from a Webform Template and query parameters that are provided through the Webform URL when creating or updating a request.",
            "type": "object",
            "example": "Address = Bangalore",
            "additionalProperties": {
              "type": "string"
            }
          }
        }
      },
      "PrivacyAutomation-DataSubjectRequestDSRAutomation_RequestV2AttachmentDto": {
        "type": "object",
        "properties": {
          "fileName": {
            "type": "string"
          },
          "fileId": {
            "type": "string",
            "format": "uuid"
          }
        }
      },
      "PrivacyAutomation-DataSubjectRequestDSRAutomation_RequestV2CommentDto": {
        "type": "object",
        "properties": {
          "commentString": {
            "type": "string"
          },
          "commentId": {
            "type": "string",
            "format": "uuid"
          },
          "commentStatus": {
            "type": "integer",
            "format": "int64"
          },
          "commentAuthor": {
            "type": "string"
          },
          "commentTimeStamp": {
            "type": "string",
            "format": "date-time"
          },
          "attachments": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PrivacyAutomation-DataSubjectRequestDSRAutomation_RequestV2AttachmentDto"
            }
          },
          "internalComment": {
            "type": "boolean"
          }
        }
      }
    },
    "securitySchemes": {
      "PrivacyAutomation-DataSubjectRequestDSRAutomation_OAUTH2": {
        "type": "oauth2",
        "flows": {
          "clientCredentials": {
            "tokenUrl": "https://{hostname}/api/access/v1/oauth/token",
            "scopes": {
              "DSAR_READ": "Read-only access to DSAR objects scope for external systems",
              "DSAR_WRITE": "Access to DSAR objects scope for external systems",
              "DSAR": "Access to DSAR objects scope for external systems"
            }
          }
        }
      }
    }
  },
  "x-readme": {
    "explorer-enabled": false,
    "proxy-enabled": false,
    "metrics-enabled": false
  },
  "x-onetrust": {
    "spec-label": "OpenAPI 3.1.0"
  }
}
```

# Sibling pages

* [Create Request](https://developer.onetrust.com/onetrust/reference/createrequestqueuefrommessageusingpost.md)
* [Get Deletion Certificate](https://developer.onetrust.com/onetrust/reference/getdeletioncertificateusingget.md)
* [Delete Requests](https://developer.onetrust.com/onetrust/reference/bulkdeleteusingput.md)
* [Search Requests](https://developer.onetrust.com/onetrust/reference/searchforrequestusingpost.md)
* [Get Request Audit History](https://developer.onetrust.com/onetrust/reference/getrequesthistorybyidusingget.md)
* [Get Request Creation Logs](https://developer.onetrust.com/onetrust/reference/getrequestcreationlogsusingget.md)
* [Get List of Requests](https://developer.onetrust.com/onetrust/reference/getallrequestqueuesv2usingget.md)
* [Add Comment to Request](https://developer.onetrust.com/onetrust/reference/addcommentsusingput.md)
* [Update Request Custom Fields](https://developer.onetrust.com/onetrust/reference/updatecustomfieldsusingput.md)
* [Update Request Stage](https://developer.onetrust.com/onetrust/reference/movestatusbyrequestrefidusingput.md)
* [Link Requests](https://developer.onetrust.com/onetrust/reference/linkrequestsusingput.md)
* [Pause Request Deadline](https://developer.onetrust.com/onetrust/reference/pauseorresumedeadlineusingput.md)
* [Create Request](https://developer.onetrust.com/onetrust/reference/createrequestqueuev2usingpost.md)
* [Get Request Audit History](https://developer.onetrust.com/onetrust/reference/getrequesthistory.md)