OneTrust

App · 25 actions

Run privacy work in OneTrust from your workflows: log and move privacy rights requests through their stages, record and withdraw consent, launch assessments, keep the data inventory current and log incidents. Start a workflow when a request comes in or nears its deadline, an assessment is completed, or consent changes.

Actions

ActionWhat it does
Add comment to requestComment on a request, for your team only or for the person too, in their privacy portal.
Add task to requestGive someone a task on a request, such as finding the person's data in a system, with a deadline and a reminder.
Change incident stageMove an incident to another stage of its workflow, such as Investigating.
Change request stageMove a request to another stage of its workflow, such as In progress or Complete.
Create incidentLog an incident, such as a misdirected email or a lost laptop, in the incident register.
Create inventory recordAdd an asset, processing activity, vendor or legal entity to the data inventory.
Create requestLog a privacy rights request for a person, as if they had sent one of your web forms.
Delete inventory recordDelete a record from the data inventory: marked deleted, where it can be restored, or gone for good.
Delete requestDelete a request for good, with its tasks, attachments and results.
Find incidentsFind incidents, newest first, by words in their name, description, type, assignee or root cause.
Find requestsFind privacy rights requests by the person's name or email, or by the request's ID.
Get assessmentGet an assessment with its status, result, risks, respondents, approvers, and every question with its answer.
Get consentGet a person's consent for every purpose: given, withdrawn or expired, and when.
Get incidentGet an incident with its type, stage, assignee and dates.
Get inventory recordGet an asset, processing activity, vendor or legal entity from the data inventory.
Get requestGet a privacy rights request with its stage, deadline, form fields and comments.
Launch assessmentLaunch an assessment from a published template and send it to its respondents, who are invited by email.
List assessmentsList assessments, such as privacy impact and vendor risk assessments, newest first, by status and kind.
List inventory recordsList assets, processing activities, vendors or legal entities in the data inventory, 50 at most a page, optionally matching words.
List purposesList the consent purposes people can agree to, such as Marketing Communications, at their latest version.
List requestsList privacy rights requests (DSARs), newest first, by stage and by when they were submitted or last changed.
Record consentRecord a person's consent choice for one or more purposes, through a collection point of the API kind, as a consent receipt.
Update inventory recordChange a record in the data inventory.
Update request fieldsChange the answers in a request's form fields.
Withdraw consentWithdraw a person's consent for one purpose on their behalf, such as when they ask by email or phone.

Add comment to request

Comment on a request, for your team only or for the person too, in their privacy portal.

Inputs

RequestrequesttextRequired
The request's 10-character ID, such as SL244HWD6D, from another OneTrust step or the trigger.
CommentcommenttextRequired
What the comment says.
For your team onlyinternaltrue/false
Keep the comment out of the person's privacy portal. Turn off to show it to them.Default: true.

Outputs

commenttext
The comment added
idtext
The request's 10-character ID
internaltrue/false
Whether only your team sees it
Example output
{
  "comment": "Identity verified by phone.",
  "id": "SL244HWD6D",
  "internal": true
}

Add task to request

Give someone a task on a request, such as finding the person's data in a system, with a deadline and a reminder.

Inputs

RequestrequesttextRequired
The request's 10-character ID, such as SL244HWD6D, from another OneTrust step or the trigger.
TasknametextRequired
What the task is called, such as Data Discovery.
DetailsdescriptiontextRequired
What needs doing.
Assigneeassigneetext
The email the OneTrust user it is for signs in with. Leave blank to leave it unassigned.
Duedeadlinedate and time
When it is due.
Reminderreminderdate and time
When to remind the assignee.
Requiredrequiredtrue/false
Keep the request in its stage until the task is done.

Outputs

assigneetext
Who it is assigned to
deadlinetext
When it is due (ISO 8601)
descriptiontext
What needs doing
idtext
The task's ID
nametext
The task's name
remindertext
When a reminder is sent (ISO 8601)
request_idtext
The request's 10-character ID
requiredtrue/false
Whether the request can't move on until it is done
statustext
Where it stands, such as OPEN or ASSIGNED
Example output
{
  "assignee": "Grace Hopper",
  "deadline": "2026-11-20T12:00:00.000Z",
  "description": "Find every record about the person in the CRM.",
  "id": "e2d0f59e-3df0-4b1f-965d-d57547ed44ad",
  "name": "Data Discovery",
  "reminder": "2026-11-18T12:00:00.000Z",
  "request_id": "SL244HWD6D",
  "required": true,
  "status": "ASSIGNED"
}

Change incident stage

Move an incident to another stage of its workflow, such as Investigating.

Inputs

IncidentincidenttextRequired
The incident's ID, from another OneTrust step or the trigger, or a link to it in OneTrust.
StagestagetextRequired
The stage to move it to, by its name.

Outputs

idtext
The incident's ID
stagetext
The stage it is in now
stage_idtext
That stage's ID
Example output
{
  "id": "1d429adf-26c5-413b-9b01-e7845a5dde99",
  "stage": "Investigation",
  "stage_id": "123e4567-e89b-12d3-a456-426614174000"
}

Change request stage

Move a request to another stage of its workflow, such as In progress or Complete. A stage with required tasks left open can't be left.

Inputs

RequestrequesttextRequired
The request's 10-character ID, such as SL244HWD6D, from another OneTrust step or the trigger.
StagestagetextRequired
The stage to move it to.
Resolutionresolutiontext
Why it is rejected.Only when Stage is REJECTED.
Commentcommenttext
A note on why it is rejected.Only when Stage is REJECTED.
Comment for your team onlyinternal_commenttrue/false
Keep the comment out of the person's privacy portal.Only when Stage is REJECTED. Default: true.

Outputs

idtext
The request's 10-character ID
stagetext
The stage it is in now
Example output
{
  "id": "SL244HWD6D",
  "stage": "IN_PROGRESS"
}

Create incident

Log an incident, such as a misdirected email or a lost laptop, in the incident register.

Inputs

NamenametextRequired
What happened, in a few words.
Typeincident_typetext
The kind of incident. Leave blank for Unknown.
Descriptiondescriptiontext
What happened.
Organizationorganizationtext
The organization it belongs to. Leave blank for the one the connection's client credential was made in.
Occurredoccurred_atdate and time
When it happened.
Discovereddiscovered_atdate and time
When it was discovered.
Deadlinedeadlinedate and time
When the investigation or notice is due.
Root causeroot_causetext
Why it happened.
Notice needednotification_neededtext
Whether regulators or people must be told.One of: YES, NO, UNKNOWN (Not known yet).

Outputs

assigneetext
Who it is assigned to
closed_attext
When it was closed (ISO 8601); empty if open
created_attext
When it was logged (ISO 8601)
created_bytext
Who logged it
deadlinetext
When the investigation or notice is due (ISO 8601)
descriptiontext
What happened
discovered_attext
When it was discovered (ISO 8601)
idtext
The incident's ID
incident_typetext
Its type, such as Misdirected Email
nametext
Its name
notification_neededtext
YES, NO or UNKNOWN
numbernumber
Its number in the incident register
occurred_attext
When it happened (ISO 8601)
organizationtext
The organization it belongs to
organization_idtext
That organization's ID
root_causetext
Its root cause
stagetext
The workflow stage it is in, such as Investigating
statustext
OPEN or CLOSED
updated_attext
When it last changed (ISO 8601); empty in searches
Example output
{
  "assignee": "Grace Hopper",
  "closed_at": "",
  "created_at": "2026-04-21T14:10:00.187Z",
  "created_by": "Grace Hopper",
  "deadline": "2026-04-23T05:22:40.187Z",
  "description": "A customer list was emailed to the wrong address.",
  "discovered_at": "2026-04-21T12:22:40.187Z",
  "id": "1d429adf-26c5-413b-9b01-e7845a5dde99",
  "incident_type": "Misdirected Email",
  "name": "Joe sent an email to the wrong client",
  "notification_needed": "UNKNOWN",
  "number": 1,
  "occurred_at": "2026-04-21T05:22:40.187Z",
  "organization": "Business Unit",
  "organization_id": "123e4567-e89b-12d3-a456-426614174000",
  "root_cause": "",
  "stage": "Investigating",
  "status": "OPEN",
  "updated_at": "2026-04-21T14:10:00.187Z"
}

Create inventory record

Add an asset, processing activity, vendor or legal entity to the data inventory. Assets and legal entities need a location, and vendors a type.

Inputs

Typerecord_typetextRequired
What kind of inventory record it is.One of: assets, processing-activities (Processing activities), vendors, entities (Legal entities).
NamenametextRequired
What the record is called.
Locationlocationtext
Where the asset is hosted, or where the legal entity mainly operates.Only when Type is Assets or Legal entities.
Vendor typevendor_typetext
What kind of vendor it is.Only when Type is Vendors.
Organizationorganizationtext
The organization it belongs to. Leave blank for the one the connection's client credential was made in.
Other fieldsfieldsobject
More of the record's fields, by their key in OneTrust, such as {"description": "Hosts the CRM"}.

Outputs

created_attext
When it was added (ISO 8601)
external_idtext
Its ID in another system; empty if none
idtext
The record's ID
linktext
A link to it in OneTrust; empty if OneTrust didn't say
locationtext
Where an asset is hosted, or a legal entity operates
nametext
Its name
numbernumber
Its number in OneTrust
organizationtext
The organization it belongs to
organization_idtext
That organization's ID
record_typetext
assets, processing-activities, vendors or entities
risk_leveltext
Its risk level, such as HIGH; empty if not scored
risk_scorenumber
Its risk score; 0 if not scored
select_fieldsobject
Its choice fields, by their key, each a list of the values chosen
statustext
Its status, such as active
text_fieldsobject
Its text fields, by their key
updated_attext
When it last changed (ISO 8601)
vendor_typetext
A vendor's type, such as Technology
Example output
{
  "created_at": "2023-05-29T12:06:35.787Z",
  "external_id": "",
  "id": "9a7c3ec1-7830-4811-8563-36e0a093e7ae",
  "link": "https://app.onetrust.com/inventory/details/vendors/9a7c3ec1-7830-4811-8563-36e0a093e7ae",
  "location": "",
  "name": "Vendor Name",
  "number": 1,
  "organization": "aws",
  "organization_id": "01d5d6db-a3f0-424e-9956-cfa205dc8af7",
  "record_type": "vendors",
  "risk_level": "HIGH",
  "risk_score": 8.5,
  "select_fields": {
    "data-residency": [
      "US"
    ]
  },
  "status": "active",
  "text_fields": {
    "description": "Sample description"
  },
  "updated_at": "2023-06-02T06:29:44.717Z",
  "vendor_type": "Operations"
}

Create request

Log a privacy rights request for a person, as if they had sent one of your web forms. The form's workflow and emails apply.

Inputs

Web formweb_formtextRequired
The web form the request is made through. Its ID ends the address of the form's page in OneTrust.
EmailemailtextRequired
The person's email address.
First namefirst_nametextRequired
The person's first name.
Last namelast_nametext
The person's last name.
Request typesrequest_typeslist
What they ask for, as the web form names it, such as Delete Data.
Subject typessubject_typeslist
Who they are to you, as the web form names it, such as Customer.
Languagelanguagetext
The language OneTrust writes to the person in.One of: en-us (English (U.S.)), en-gb (English (British)), ar (Arabic), zh-cn (Chinese (Simplified)), zh-tw (Chinese (Traditional)), cs (Czech), da (Danish), nl (Dutch), fi (Finnish), fr (French), and 23 more. Default: en-us.
Other form fieldsfieldsobject
Answers to the web form's other fields, by their key, such as {"requestDetails": "Please delete my account"}.

Outputs

approvertext
Who the request is assigned to
approver_emailtext
Their email; empty in lists
completed_attext
When it was completed (ISO 8601); empty if open
countrytext
The person's country
country_codetext
The person's country code, such as US
created_attext
When it was submitted (ISO 8601)
days_leftnumber
Days left until the deadline
deadlinetext
When it must be answered by (ISO 8601)
emailtext
The person's email
extendedtrue/false
Whether the deadline was extended
fieldsobject
The request's form fields, by their key, as OneTrust gives them
first_nametext
The person's first name
idtext
The request's 10-character ID, such as SL244HWD6D
languagetext
The request's language code, such as en-us
last_nametext
The person's last name
organizationtext
The organization the request belongs to
request_typeslist
What the person asked for, such as Data Portability
resolutiontext
The resolution it was closed or rejected with
stagetext
The workflow stage it is in, such as NEW or IN_PROGRESS
subject_typeslist
Who the person is to you, such as Customer
updated_attext
When it last changed (ISO 8601)
uuidtext
The request's long ID (a UUID)
web_formtext
The web form it came in through
web_form_idtext
That web form's ID
workflowtext
The request workflow it follows
Example output
{
  "approver": "Grace Hopper",
  "approver_email": "grace@example.com",
  "completed_at": "",
  "country": "United States",
  "country_code": "US",
  "created_at": "2026-11-06T12:49:47.983Z",
  "days_left": 30,
  "deadline": "2026-12-06T12:49:47.920Z",
  "email": "ada@example.com",
  "extended": false,
  "fields": {
    "requestDetails": "Please send me a copy of my data."
  },
  "first_name": "Ada",
  "id": "SL244HWD6D",
  "language": "en-us",
  "last_name": "Lovelace",
  "organization": "Example Corp",
  "request_types": [
    "Data Portability",
    "Update Data"
  ],
  "resolution": "",
  "stage": "NEW",
  "subject_types": [
    "Customer"
  ],
  "updated_at": "2026-11-06T13:10:15.470Z",
  "uuid": "e2d0f59e-3df0-4b1f-965d-d57547ed44ad",
  "web_form": "Privacy Request Form",
  "web_form_id": "6519ffd5-fe6b-4804-8dfc-1c2ae2da212d",
  "workflow": "Default Workflow"
}

Delete inventory record

Delete a record from the data inventory: marked deleted, where it can be restored, or gone for good.

Inputs

Typerecord_typetextRequired
What kind of inventory record it is.One of: assets, processing-activities (Processing activities), vendors, entities (Legal entities).
RecordrecordtextRequired
The record's ID, from another OneTrust step or the trigger, or a link to it in OneTrust.
Delete for goodpermanentlytrue/false
Delete it for good, rather than marking it deleted.Default: false.
Reasonreasontext
Why it is deleted, kept for the audit trail.

Outputs

deletedtrue/false
Whether OneTrust deleted it
idtext
The record's ID
permanentlytrue/false
Whether it is gone for good rather than marked deleted
record_typetext
Its type
Example output
{
  "deleted": true,
  "id": "9a7c3ec1-7830-4811-8563-36e0a093e7ae",
  "permanently": false,
  "record_type": "vendors"
}

Delete request

Delete a request for good, with its tasks, attachments and results. It can't be undone.

Inputs

RequestrequesttextRequired
The request's 10-character ID, such as SL244HWD6D, from another OneTrust step or the trigger.

Outputs

deletedtrue/false
Whether OneTrust deleted it
idtext
The request's 10-character ID
Example output
{
  "deleted": true,
  "id": "SL244HWD6D"
}

Find incidents

Find incidents, newest first, by words in their name, description, type, assignee or root cause. Leave the search blank to list the newest.

Inputs

Searchsearchtext
Words to look for, such as laptop.
How manylimitnumber
The most to list. Defaults to 25.From 1 to 500.

Outputs

countnumber
How many are listed
incidentslist
The incidents found
totalnumber
How many match in all
Example output
{
  "count": 1,
  "incidents": [
    {
      "assignee": "Grace Hopper",
      "closed_at": "",
      "created_at": "2026-04-21T14:10:00.187Z",
      "created_by": "Grace Hopper",
      "deadline": "2026-04-23T05:22:40.187Z",
      "description": "A customer list was emailed to the wrong address.",
      "discovered_at": "2026-04-21T12:22:40.187Z",
      "id": "1d429adf-26c5-413b-9b01-e7845a5dde99",
      "incident_type": "Misdirected Email",
      "name": "Joe sent an email to the wrong client",
      "notification_needed": "UNKNOWN",
      "number": 1,
      "occurred_at": "2026-04-21T05:22:40.187Z",
      "organization": "Business Unit",
      "organization_id": "123e4567-e89b-12d3-a456-426614174000",
      "root_cause": "",
      "stage": "Investigating",
      "status": "OPEN",
      "updated_at": "2026-04-21T14:10:00.187Z"
    }
  ],
  "total": 1
}

Find requests

Find privacy rights requests by the person's name or email, or by the request's ID.

Inputs

SearchsearchtextRequired
A name, email or request ID, such as ada@example.com.
Submitted sincecreated_sincedate
Only requests submitted on or after this day.
How manylimitnumber
The most to list. Defaults to 25.From 1 to 500.

Outputs

countnumber
How many are listed
requestslist
The requests found
totalnumber
How many match in all
Example output
{
  "count": 1,
  "requests": [
    {
      "approver": "Grace Hopper",
      "approver_email": "grace@example.com",
      "completed_at": "",
      "country": "United States",
      "country_code": "US",
      "created_at": "2026-11-06T12:49:47.983Z",
      "days_left": 30,
      "deadline": "2026-12-06T12:49:47.920Z",
      "email": "ada@example.com",
      "extended": false,
      "fields": {
        "requestDetails": "Please send me a copy of my data."
      },
      "first_name": "Ada",
      "id": "SL244HWD6D",
      "language": "en-us",
      "last_name": "Lovelace",
      "organization": "Example Corp",
      "request_types": [
        "Data Portability",
        "Update Data"
      ],
      "resolution": "",
      "stage": "NEW",
      "subject_types": [
        "Customer"
      ],
      "updated_at": "2026-11-06T13:10:15.470Z",
      "uuid": "e2d0f59e-3df0-4b1f-965d-d57547ed44ad",
      "web_form": "Privacy Request Form",
      "web_form_id": "6519ffd5-fe6b-4804-8dfc-1c2ae2da212d",
      "workflow": "Default Workflow"
    }
  ],
  "total": 1
}

Get assessment

Get an assessment with its status, result, risks, respondents, approvers, and every question with its answer.

Inputs

AssessmentassessmenttextRequired
The assessment's ID, from another OneTrust step or the trigger, or a link to it in OneTrust.

Outputs

answerslist
Every question and its answer
approverslist
Who approves it, and where each stands
completed_attext
When it was completed (ISO 8601)
created_attext
When it was launched (ISO 8601)
created_bytext
Who launched it
deadlinetext
When it is due (ISO 8601); empty if no deadline
descriptiontext
Its description
idtext
The assessment's ID
nametext
Its name
numbernumber
Its number in OneTrust
open_risksnumber
How many of its risks are open
organizationtext
The organization it belongs to
respondentslist
Who answers it
resulttext
Its result once reviewed, such as Approved
risk_leveltext
Its overall risk level, such as LOW
statustext
NOT_STARTED, IN_PROGRESS, UNDER_REVIEW or COMPLETED
submitted_attext
When it was submitted for review (ISO 8601)
templatetext
The template it was launched from
total_risksnumber
How many risks it found
updated_attext
When it last changed (ISO 8601)
Example output
{
  "answers": [
    {
      "answer": "Name; Email",
      "question": "Which personal data does the project collect?",
      "section": "Data collected"
    }
  ],
  "approvers": [
    {
      "name": "Jane Smith",
      "state": "APPROVED"
    }
  ],
  "completed_at": "2026-11-15T14:22:33Z",
  "created_at": "2026-01-15T10:30:45Z",
  "created_by": "Grace Hopper",
  "deadline": "2026-12-31T23:59:59Z",
  "description": "Annual GDPR compliance assessment",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "GDPR Assessment",
  "number": 12345,
  "open_risks": 2,
  "organization": "Legal Department",
  "respondents": [
    "Bob Johnson"
  ],
  "result": "Approved",
  "risk_level": "LOW",
  "status": "COMPLETED",
  "submitted_at": "2026-11-10T09:15:30Z",
  "template": "PIA Template",
  "total_risks": 6,
  "updated_at": "2026-11-05T16:42:18Z"
}

Get a person's consent for every purpose: given, withdrawn or expired, and when.

Inputs

PersonidentifiertextRequired
The person's identifier in OneTrust's consent records, usually their email.

Outputs

countnumber
How many purposes are listed
foundtrue/false
Whether OneTrust has consent records for them
identifiertext
The person's identifier, such as their email
purposeslist
Their consent for each purpose
Example output
{
  "count": 1,
  "found": true,
  "identifier": "ada@example.com",
  "purposes": [
    {
      "collection_point_id": "25d9ccac-db88-4d34-849c-3d602a629961",
      "consent_date": "2026-01-07T13:18:23.123Z",
      "expiry_date": "",
      "last_transaction_date": "2026-01-12T16:11:25.479Z",
      "purpose": "Marketing Communications",
      "purpose_id": "f2229953-b4b5-4042-8cb9-b78038cc4c46",
      "status": "ACTIVE",
      "version": 2,
      "withdrawal_date": ""
    }
  ]
}

Get incident

Get an incident with its type, stage, assignee and dates.

Inputs

IncidentincidenttextRequired
The incident's ID, from another OneTrust step or the trigger, or a link to it in OneTrust.

Outputs

assigneetext
Who it is assigned to
closed_attext
When it was closed (ISO 8601); empty if open
created_attext
When it was logged (ISO 8601)
created_bytext
Who logged it
deadlinetext
When the investigation or notice is due (ISO 8601)
descriptiontext
What happened
discovered_attext
When it was discovered (ISO 8601)
idtext
The incident's ID
incident_typetext
Its type, such as Misdirected Email
nametext
Its name
notification_neededtext
YES, NO or UNKNOWN
numbernumber
Its number in the incident register
occurred_attext
When it happened (ISO 8601)
organizationtext
The organization it belongs to
organization_idtext
That organization's ID
root_causetext
Its root cause
stagetext
The workflow stage it is in, such as Investigating
statustext
OPEN or CLOSED
updated_attext
When it last changed (ISO 8601); empty in searches
Example output
{
  "assignee": "Grace Hopper",
  "closed_at": "",
  "created_at": "2026-04-21T14:10:00.187Z",
  "created_by": "Grace Hopper",
  "deadline": "2026-04-23T05:22:40.187Z",
  "description": "A customer list was emailed to the wrong address.",
  "discovered_at": "2026-04-21T12:22:40.187Z",
  "id": "1d429adf-26c5-413b-9b01-e7845a5dde99",
  "incident_type": "Misdirected Email",
  "name": "Joe sent an email to the wrong client",
  "notification_needed": "UNKNOWN",
  "number": 1,
  "occurred_at": "2026-04-21T05:22:40.187Z",
  "organization": "Business Unit",
  "organization_id": "123e4567-e89b-12d3-a456-426614174000",
  "root_cause": "",
  "stage": "Investigating",
  "status": "OPEN",
  "updated_at": "2026-04-21T14:10:00.187Z"
}

Get inventory record

Get an asset, processing activity, vendor or legal entity from the data inventory.

Inputs

Typerecord_typetextRequired
What kind of inventory record it is.One of: assets, processing-activities (Processing activities), vendors, entities (Legal entities).
RecordrecordtextRequired
The record's ID, from another OneTrust step or the trigger, or a link to it in OneTrust.

Outputs

created_attext
When it was added (ISO 8601)
external_idtext
Its ID in another system; empty if none
idtext
The record's ID
linktext
A link to it in OneTrust; empty if OneTrust didn't say
locationtext
Where an asset is hosted, or a legal entity operates
nametext
Its name
numbernumber
Its number in OneTrust
organizationtext
The organization it belongs to
organization_idtext
That organization's ID
record_typetext
assets, processing-activities, vendors or entities
risk_leveltext
Its risk level, such as HIGH; empty if not scored
risk_scorenumber
Its risk score; 0 if not scored
select_fieldsobject
Its choice fields, by their key, each a list of the values chosen
statustext
Its status, such as active
text_fieldsobject
Its text fields, by their key
updated_attext
When it last changed (ISO 8601)
vendor_typetext
A vendor's type, such as Technology
Example output
{
  "created_at": "2023-05-29T12:06:35.787Z",
  "external_id": "",
  "id": "9a7c3ec1-7830-4811-8563-36e0a093e7ae",
  "link": "https://app.onetrust.com/inventory/details/vendors/9a7c3ec1-7830-4811-8563-36e0a093e7ae",
  "location": "",
  "name": "Vendor Name",
  "number": 1,
  "organization": "aws",
  "organization_id": "01d5d6db-a3f0-424e-9956-cfa205dc8af7",
  "record_type": "vendors",
  "risk_level": "HIGH",
  "risk_score": 8.5,
  "select_fields": {
    "data-residency": [
      "US"
    ]
  },
  "status": "active",
  "text_fields": {
    "description": "Sample description"
  },
  "updated_at": "2023-06-02T06:29:44.717Z",
  "vendor_type": "Operations"
}

Get request

Get a privacy rights request with its stage, deadline, form fields and comments.

Inputs

RequestrequesttextRequired
The request's 10-character ID, such as SL244HWD6D, from another OneTrust step or the trigger.

Outputs

approvertext
Who the request is assigned to
approver_emailtext
Their email; empty in lists
commentslist
Comments on the request
completed_attext
When it was completed (ISO 8601); empty if open
countrytext
The person's country
country_codetext
The person's country code, such as US
created_attext
When it was submitted (ISO 8601)
days_leftnumber
Days left until the deadline
deadlinetext
When it must be answered by (ISO 8601)
emailtext
The person's email
extendedtrue/false
Whether the deadline was extended
fieldsobject
The request's form fields, by their key, as OneTrust gives them
first_nametext
The person's first name
idtext
The request's 10-character ID, such as SL244HWD6D
languagetext
The request's language code, such as en-us
last_nametext
The person's last name
organizationtext
The organization the request belongs to
request_typeslist
What the person asked for, such as Data Portability
resolutiontext
The resolution it was closed or rejected with
stagetext
The workflow stage it is in, such as NEW or IN_PROGRESS
subject_typeslist
Who the person is to you, such as Customer
updated_attext
When it last changed (ISO 8601)
uuidtext
The request's long ID (a UUID)
web_formtext
The web form it came in through
web_form_idtext
That web form's ID
workflowtext
The request workflow it follows
Example output
{
  "approver": "Grace Hopper",
  "approver_email": "grace@example.com",
  "comments": [
    {
      "at": "2026-11-06T13:10:15.470Z",
      "author": "Grace Hopper",
      "internal": true,
      "text": "Identity verified by phone."
    }
  ],
  "completed_at": "",
  "country": "United States",
  "country_code": "US",
  "created_at": "2026-11-06T12:49:47.983Z",
  "days_left": 30,
  "deadline": "2026-12-06T12:49:47.920Z",
  "email": "ada@example.com",
  "extended": false,
  "fields": {
    "requestDetails": "Please send me a copy of my data."
  },
  "first_name": "Ada",
  "id": "SL244HWD6D",
  "language": "en-us",
  "last_name": "Lovelace",
  "organization": "Example Corp",
  "request_types": [
    "Data Portability",
    "Update Data"
  ],
  "resolution": "",
  "stage": "NEW",
  "subject_types": [
    "Customer"
  ],
  "updated_at": "2026-11-06T13:10:15.470Z",
  "uuid": "e2d0f59e-3df0-4b1f-965d-d57547ed44ad",
  "web_form": "Privacy Request Form",
  "web_form_id": "6519ffd5-fe6b-4804-8dfc-1c2ae2da212d",
  "workflow": "Default Workflow"
}

Launch assessment

Launch an assessment from a published template and send it to its respondents, who are invited by email.

Inputs

TemplatetemplatetextRequired
The published template to launch it from.
NamenametextRequired
What the assessment is called.
RespondentsrespondentslistRequired
The emails of the people who answer it.
Descriptiondescriptiontext
What it is about.
Duedeadlinedate and time
When it must be finished.
Remind days beforereminder_daysnumber
How many days before the deadline to remind respondents.From 1 to 365.
Organizationorganizationtext
The organization it belongs to. Leave blank for the one the connection's client credential was made in.

Outputs

idtext
The new assessment's ID
nametext
Its name
template_idtext
The template it was launched from
Example output
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "GDPR Assessment",
  "template_id": "7d271be5-0601-4190-96a7-65d7c427a725"
}

List assessments

List assessments, such as privacy impact and vendor risk assessments, newest first, by status and kind.

Inputs

Statusesstatuseslist
Only assessments with these statuses. Leave blank for all.One or more of: NOT_STARTED (Not started), IN_PROGRESS (In progress), UNDER_REVIEW (Under review), COMPLETED.
Kindstemplate_typeslist
Only assessments of these kinds. Leave blank for all.One or more of: PIA (Privacy impact (PIA and DPIA)), VENDOR (Third-party risk), ITRM (IT and security risk), CONTROL (Controls), INCIDENT (Incidents), ESG, AIGOVERNANCE (AI governance).
How manylimitnumber
The most to list. Defaults to 25.From 1 to 500.

Outputs

assessmentslist
The assessments found
countnumber
How many are listed
totalnumber
How many match in all
Example output
{
  "assessments": [
    {
      "created_at": "2026-07-01T10:30:00Z",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "inherent_risk_score": 7.2,
      "name": "Annual Security Review",
      "number": 12345,
      "open_risks": 5,
      "organization": "Finance Department",
      "primary_record": "Server Infrastructure",
      "residual_risk_score": 3.5,
      "result": "",
      "status": "IN_PROGRESS",
      "template": "Security Assessment Template v2",
      "template_id": "123e4567-e89b-12d3-a456-426614174002",
      "updated_at": "2026-07-23T15:30:45Z"
    }
  ],
  "count": 1,
  "total": 1
}

List inventory records

List assets, processing activities, vendors or legal entities in the data inventory, 50 at most a page, optionally matching words.

Inputs

Typerecord_typetextRequired
What kind of inventory record it is.One of: assets, processing-activities (Processing activities), vendors, entities (Legal entities).
Searchsearchtext
Words in the record, such as its name.
Pagepagenumber
Which page of results to list. Defaults to the first.From 1 to 10000.
How manylimitnumber
The most to list. Defaults to 25.From 1 to 50.

Outputs

countnumber
How many are listed
recordslist
The records found
totalnumber
How many match in all
Example output
{
  "count": 1,
  "records": [
    {
      "created_at": "2023-05-29T12:06:35.787Z",
      "external_id": "",
      "id": "9a7c3ec1-7830-4811-8563-36e0a093e7ae",
      "link": "https://app.onetrust.com/inventory/details/vendors/9a7c3ec1-7830-4811-8563-36e0a093e7ae",
      "location": "",
      "name": "Vendor Name",
      "number": 1,
      "organization": "aws",
      "organization_id": "01d5d6db-a3f0-424e-9956-cfa205dc8af7",
      "record_type": "vendors",
      "risk_level": "HIGH",
      "risk_score": 8.5,
      "select_fields": {
        "data-residency": [
          "US"
        ]
      },
      "status": "active",
      "text_fields": {
        "description": "Sample description"
      },
      "updated_at": "2023-06-02T06:29:44.717Z",
      "vendor_type": "Operations"
    }
  ],
  "total": 1
}

List purposes

List the consent purposes people can agree to, such as Marketing Communications, at their latest version.

Inputs

Include retiredinclude_retiredtrue/false
List retired purposes too.Default: false.
How manylimitnumber
The most to list. Defaults to 25.From 1 to 100.

Outputs

countnumber
How many are listed
purposeslist
The purposes
totalnumber
How many match in all
Example output
{
  "count": 1,
  "purposes": [
    {
      "created_at": "2023-01-01T00:00:00Z",
      "description": "Collect customer emails for marketing purposes",
      "id": "f2229953-b4b5-4042-8cb9-b78038cc4c46",
      "name": "Marketing Communications",
      "purpose_type": "STANDARD",
      "status": "ACTIVE",
      "updated_at": "2023-01-15T15:30:45Z",
      "version": 2
    }
  ],
  "total": 1
}

List requests

List privacy rights requests (DSARs), newest first, by stage and by when they were submitted or last changed.

Inputs

Stagestagetext
Only requests in this stage. Leave blank for every stage.
Submitted sincecreated_sincedate
Only requests submitted on or after this day.
Changed sinceupdated_sincedate
Only requests changed on or after this day.
How manylimitnumber
The most to list. Defaults to 25.From 1 to 500.

Outputs

countnumber
How many are listed
requestslist
The requests found
totalnumber
How many match in all
Example output
{
  "count": 1,
  "requests": [
    {
      "approver": "Grace Hopper",
      "approver_email": "grace@example.com",
      "completed_at": "",
      "country": "United States",
      "country_code": "US",
      "created_at": "2026-11-06T12:49:47.983Z",
      "days_left": 30,
      "deadline": "2026-12-06T12:49:47.920Z",
      "email": "ada@example.com",
      "extended": false,
      "fields": {
        "requestDetails": "Please send me a copy of my data."
      },
      "first_name": "Ada",
      "id": "SL244HWD6D",
      "language": "en-us",
      "last_name": "Lovelace",
      "organization": "Example Corp",
      "request_types": [
        "Data Portability",
        "Update Data"
      ],
      "resolution": "",
      "stage": "NEW",
      "subject_types": [
        "Customer"
      ],
      "updated_at": "2026-11-06T13:10:15.470Z",
      "uuid": "e2d0f59e-3df0-4b1f-965d-d57547ed44ad",
      "web_form": "Privacy Request Form",
      "web_form_id": "6519ffd5-fe6b-4804-8dfc-1c2ae2da212d",
      "workflow": "Default Workflow"
    }
  ],
  "total": 1
}

Record a person's consent choice for one or more purposes, through a collection point of the API kind, as a consent receipt.

Inputs

Collection pointcollection_pointtextRequired
The collection point of the API kind the consent is recorded through.
PersonidentifiertextRequired
The person's identifier in OneTrust's consent records, usually their email.
PurposespurposeslistRequired
The purposes the choice is for, at most 20.
Choiceconsenttext
What the person chose.One of: CONFIRMED (Gave consent), NO_CHOICE (Made no choice), OPT_OUT (Opted out), WITHDRAWN (Withdrew consent). Default: CONFIRMED.
Test recordtesttrue/false
Mark the person as a test record. This can't be undone.Default: false.

Outputs

consenttext
What was recorded, such as CONFIRMED
identifiertext
The person's identifier
link_tokentext
A token for the person's preference center; often empty
purposeslist
The purposes it was recorded for
receipttext
OneTrust's receipt for it, a signed token
Example output
{
  "consent": "CONFIRMED",
  "identifier": "ada@example.com",
  "link_token": "",
  "purposes": [
    "f2229953-b4b5-4042-8cb9-b78038cc4c46"
  ],
  "receipt": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJyZWNlaXB0In0.c2ln"
}

Update inventory record

Change a record in the data inventory. Fields left blank keep their values.

Inputs

Typerecord_typetextRequired
What kind of inventory record it is.One of: assets, processing-activities (Processing activities), vendors, entities (Legal entities).
RecordrecordtextRequired
The record's ID, from another OneTrust step or the trigger, or a link to it in OneTrust.
Namenametext
A new name. Leave blank to keep it.
Organizationorganizationtext
A new organization for it. Leave blank to keep it.
Other fieldsfieldsobject
More of the record's fields, by their key in OneTrust, such as {"description": "Hosts the CRM"}.

Outputs

created_attext
When it was added (ISO 8601)
external_idtext
Its ID in another system; empty if none
idtext
The record's ID
linktext
A link to it in OneTrust; empty if OneTrust didn't say
locationtext
Where an asset is hosted, or a legal entity operates
nametext
Its name
numbernumber
Its number in OneTrust
organizationtext
The organization it belongs to
organization_idtext
That organization's ID
record_typetext
assets, processing-activities, vendors or entities
risk_leveltext
Its risk level, such as HIGH; empty if not scored
risk_scorenumber
Its risk score; 0 if not scored
select_fieldsobject
Its choice fields, by their key, each a list of the values chosen
statustext
Its status, such as active
text_fieldsobject
Its text fields, by their key
updated_attext
When it last changed (ISO 8601)
vendor_typetext
A vendor's type, such as Technology
Example output
{
  "created_at": "2023-05-29T12:06:35.787Z",
  "external_id": "",
  "id": "9a7c3ec1-7830-4811-8563-36e0a093e7ae",
  "link": "https://app.onetrust.com/inventory/details/vendors/9a7c3ec1-7830-4811-8563-36e0a093e7ae",
  "location": "",
  "name": "Vendor Name",
  "number": 1,
  "organization": "aws",
  "organization_id": "01d5d6db-a3f0-424e-9956-cfa205dc8af7",
  "record_type": "vendors",
  "risk_level": "HIGH",
  "risk_score": 8.5,
  "select_fields": {
    "data-residency": [
      "US"
    ]
  },
  "status": "active",
  "text_fields": {
    "description": "Sample description"
  },
  "updated_at": "2023-06-02T06:29:44.717Z",
  "vendor_type": "Operations"
}

Update request fields

Change the answers in a request's form fields. Fields left out keep their values.

Inputs

RequestrequesttextRequired
The request's 10-character ID, such as SL244HWD6D, from another OneTrust step or the trigger.
FieldsfieldsobjectRequired
The fields to change, by their key, with their new values, such as {"requestDetails": "Account closed in March"}.

Outputs

approvertext
Who the request is assigned to
approver_emailtext
Their email; empty in lists
completed_attext
When it was completed (ISO 8601); empty if open
countrytext
The person's country
country_codetext
The person's country code, such as US
created_attext
When it was submitted (ISO 8601)
days_leftnumber
Days left until the deadline
deadlinetext
When it must be answered by (ISO 8601)
emailtext
The person's email
extendedtrue/false
Whether the deadline was extended
fieldsobject
The request's form fields, by their key, as OneTrust gives them
first_nametext
The person's first name
idtext
The request's 10-character ID, such as SL244HWD6D
languagetext
The request's language code, such as en-us
last_nametext
The person's last name
organizationtext
The organization the request belongs to
request_typeslist
What the person asked for, such as Data Portability
resolutiontext
The resolution it was closed or rejected with
stagetext
The workflow stage it is in, such as NEW or IN_PROGRESS
subject_typeslist
Who the person is to you, such as Customer
updated_attext
When it last changed (ISO 8601)
uuidtext
The request's long ID (a UUID)
web_formtext
The web form it came in through
web_form_idtext
That web form's ID
workflowtext
The request workflow it follows
Example output
{
  "approver": "Grace Hopper",
  "approver_email": "grace@example.com",
  "completed_at": "",
  "country": "United States",
  "country_code": "US",
  "created_at": "2026-11-06T12:49:47.983Z",
  "days_left": 30,
  "deadline": "2026-12-06T12:49:47.920Z",
  "email": "ada@example.com",
  "extended": false,
  "fields": {
    "requestDetails": "Please send me a copy of my data."
  },
  "first_name": "Ada",
  "id": "SL244HWD6D",
  "language": "en-us",
  "last_name": "Lovelace",
  "organization": "Example Corp",
  "request_types": [
    "Data Portability",
    "Update Data"
  ],
  "resolution": "",
  "stage": "NEW",
  "subject_types": [
    "Customer"
  ],
  "updated_at": "2026-11-06T13:10:15.470Z",
  "uuid": "e2d0f59e-3df0-4b1f-965d-d57547ed44ad",
  "web_form": "Privacy Request Form",
  "web_form_id": "6519ffd5-fe6b-4804-8dfc-1c2ae2da212d",
  "workflow": "Default Workflow"
}

Withdraw a person's consent for one purpose on their behalf, such as when they ask by email or phone.

Inputs

PersonidentifiertextRequired
The person's identifier in OneTrust's consent records, usually their email.
PurposepurposetextRequired
The purpose to withdraw their consent from.
Notesnotestext
Why, kept with the withdrawal.
Withdrawn bywithdrawn_bytext
Who is withdrawing it, kept with the withdrawal. Defaults to Lodol.

Outputs

identifiertext
The person's identifier
purpose_idtext
The purpose consent was withdrawn from
statustext
OneTrust's answer
Example output
{
  "identifier": "ada@example.com",
  "purpose_id": "f2229953-b4b5-4042-8cb9-b78038cc4c46",
  "status": "Consent withdrawn successfully"
}

On this page