Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB
Request Queues

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.

get/api/datasubject/v2/requestqueues/{requestQueueRefId}/language/{language}

Path parameters

requestQueueRefIdstring required

Reference ID of the request

languagestring required

A language code that identifies the language in which the request data should be returned, assuming translations are available for that language. Examples: en-us for English, de for German, fr for French, etc.

Response

OK

requestQueueRefIdstring

Reference ID of the request. This is a 10-character ID that is unique to each request.

requestQueueIdstring uuid

The request GUID

firstNamestring

First name of the data subject.

lastNamestring

Last name of the data subject.

organizationstring

Organization to which this request is assigned.

statusstring

Current stage of the request. Various stages in the order of progression are: New, Verifying identity, In progress, Rejected, Complete.

requestTypesstring[]

Request types selected while submitting the request.

deadlinestring date-time

Deadline for the request.

isExtendedboolean

Returns true if the request complete time is being extended.

dateCreatedstring date-time

Date on which request is submitted.

dateUpdatedstring date-time

Last activity date on the request.

subjectTypesstring[]

Subject types selected while submitting the request. Subject type can be: Prospective Employee, Student, Customer, Contractor, Employee, Patient.

approverstring

Approver or assignee for the request.

languagestring

Language in which the request is created.

countryCodestring

The code for the country as per ISO 3166. e.g. US for the United States, DE for Germany.

countryNamestring

Name of the country.

emailstring

Email provided while submitting the request.

workflowstring

Name of the request workflow.

webformstring

Name of the webform.

dateCompletedstring date-time

Date on which the request is completed.

resolutionstring

Resolution selected if the request is rejected.

remainingDaysForMaxDeadlineinteger

Legal Deadline + Maximum Number of Extension Days based on country of request + Total Pause days.

maxDeadlineExtensionDatestring date-time

Legal Deadline + Maximum Number of Extension Days based on country of request + Total Pause days.

assignedToGroupboolean

Indicates if the request reviewer is assigned to a usergroup or not.

additionalStatuses'0' | '10'

Status of the request timer, such as PAUSED or ACTIVE.

daysToRespondinteger

Number of days to respond to the request.

hoursWorkednumber double

Number of hours worked.

workflowIDstring uuid

ID of the workflow associated with the request.

totalCoststring

Total cost associated with the request.

additionalDatastring

Both "additionalData" and "requestAdditionalData" hold identical information. Opt for "requestAdditionalData" for improved parsing and to prevent issues related to Unicode characters.

multiselectFieldsobject

Map of multi-select field values.

approverEmailstring

Approver or assignee's email.

requestAdditionalDataobject

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.

Example response

{
  "requestQueueRefId": "SL244HWD6D",
  "requestQueueId": "e2d0f59e-3df0-4b1f-965d-d57547ed44ad",
  "firstName": "Jonny",
  "lastName": "Sardar",
  "organization": "my own org",
  "status": "NEW",
  "requestTypes": [
    "Data Portability, Update Data"
  ],
  "deadline": "2019-09-08T12:49:47.920Z",
  "dateCreated": "2019-08-09T12:49:47.983Z",
  "dateUpdated": "2019-09-25T06:50:15.470Z",
  "subjectTypes": [
    "Student"
  ],
  "approver": "Jonny Sardar Sadmin",
  "language": "en-us",
  "countryCode": "DZ",
  "countryName": "Algeria",
  "email": "abcd@gmail.com",
  "workflow": "Default Workflow",
  "webform": "!! Nikki",
  "dateCompleted": "2019-05-31T12:43:24.173Z",
  "resolution": "Not a privacy-related request",
  "remainingDaysForMaxDeadline": 30,
  "maxDeadlineExtensionDate": "2023-09-08T12:49:47.920Z",
  "additionalStatuses": "PAUSED",
  "daysToRespond": 3,
  "hoursWorked": 40,
  "approverEmail": "js@onetrust.com"
}