--- updatedAt: 2026-05-27T12:51:18.000Z agentTools: projectIndex: https://developer.onetrust.com/onetrust/llms.txt --- # Search Requests Use this API to search for requests by key terms, such as the data subject’s first name, last name, email address, or request ID. # 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/search/{language}": { "post": { "operationId": "searchForRequestUsingPOST", "summary": "Search Requests", "description": "Use this API to search for requests by key terms, such as the data subject’s first name, last name, email address, or request ID.", "tags": [ "Request Queues" ], "x-onetrust": { "spec-label": "https://developer.onetrust.com/onetrust/openapi/privacy-automation-data-subject-request-dsr-automation.json" }, "parameters": [ { "name": "language", "in": "path", "required": true, "schema": { "description": "A language code that identifies the language in which the request data should be searched, assuming translations are available for that language. \nExamples: en-us for English, de for German, fr for French, etc.", "type": "string" }, "example": "en-us" }, { "name": "createddate", "in": "query", "required": false, "schema": { "description": "A date (yyyyMMdd). Include to retrieve a list of requests created on or after the specified date. For example, if you want to retrieve requests created on or after January 30, 2019, include the createddate=20190130 parameter in your query.", "type": "string", "format": "date" }, "example": 20190130 }, { "name": "page", "in": "query", "schema": { "description": "Results page you want to retrieve. Page number starts with 0 (0..N)", "type": "integer", "format": "int32", "default": 0, "minimum": 0 }, "example": 0 }, { "name": "size", "in": "query", "schema": { "description": "Number of records per page.", "type": "integer", "format": "int32", "default": 20, "maximum": 500, "minimum": 1 }, "example": 20 } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrivacyAutomation-DataSubjectRequestDSRAutomation_SearchV2Request" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrivacyAutomation-DataSubjectRequestDSRAutomation_SearchResultPage" } } } }, "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_PageableObject": { "type": "object", "properties": { "offset": { "type": "integer", "format": "int64" }, "sort": { "$ref": "#/components/schemas/PrivacyAutomation-DataSubjectRequestDSRAutomation_SortObject" }, "paged": { "type": "boolean" }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "unpaged": { "type": "boolean" } } }, "PrivacyAutomation-DataSubjectRequestDSRAutomation_SearchResultPage": { "type": "object", "properties": { "content": { "items": { "type": "object" }, "type": "array" }, "pageable": { "$ref": "#/components/schemas/PrivacyAutomation-DataSubjectRequestDSRAutomation_PageableObject" }, "searchTime": { "type": "integer", "format": "int64" }, "totalTime": { "type": "integer", "format": "int64" }, "searchTerms": { "type": "object", "additionalProperties": { "type": "string" } }, "last": { "type": "boolean" }, "totalElements": { "type": "integer", "format": "int64" }, "totalPages": { "type": "integer", "format": "int32" }, "size": { "type": "integer", "format": "int32" }, "number": { "type": "integer", "format": "int32" }, "sort": { "$ref": "#/components/schemas/PrivacyAutomation-DataSubjectRequestDSRAutomation_SortObject" }, "first": { "type": "boolean" }, "numberOfElements": { "type": "integer", "format": "int32" }, "empty": { "type": "boolean" } } }, "PrivacyAutomation-DataSubjectRequestDSRAutomation_SortObject": { "type": "object", "properties": { "empty": { "type": "boolean" }, "unsorted": { "type": "boolean" }, "sorted": { "type": "boolean" } } }, "PrivacyAutomation-DataSubjectRequestDSRAutomation_SearchV2Request": { "type": "object", "properties": { "term": { "type": "string" } } } }, "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) * [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) * [Get Request](https://developer.onetrust.com/onetrust/reference/getrequestbyidusingget.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)