# OneTrust

> 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.

App · 25 actions. Web page: https://docs.lodol.com/docs/integrations/onetrust

## Actions

### Add comment to request

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

**Inputs**

- Request (`request`, text, required): The request's 10-character ID, such as SL244HWD6D, from another OneTrust step or the trigger.
- Comment (`comment`, text, required): What the comment says.
- For your team only (`internal`, true/false): Keep the comment out of the person's privacy portal. Turn off to show it to them. Default: `true`.

**Outputs**

- `comment` (text): The comment added
- `id` (text): The request's 10-character ID
- `internal` (true/false): Whether only your team sees it

**Example output**

```json
{
  "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**

- Request (`request`, text, required): The request's 10-character ID, such as SL244HWD6D, from another OneTrust step or the trigger.
- Task (`name`, text, required): What the task is called, such as Data Discovery.
- Details (`description`, text, required): What needs doing.
- Assignee (`assignee`, text): The email the OneTrust user it is for signs in with. Leave blank to leave it unassigned.
- Due (`deadline`, date and time): When it is due.
- Reminder (`reminder`, date and time): When to remind the assignee.
- Required (`required`, true/false): Keep the request in its stage until the task is done.

**Outputs**

- `assignee` (text): Who it is assigned to
- `deadline` (text): When it is due (ISO 8601)
- `description` (text): What needs doing
- `id` (text): The task's ID
- `name` (text): The task's name
- `reminder` (text): When a reminder is sent (ISO 8601)
- `request_id` (text): The request's 10-character ID
- `required` (true/false): Whether the request can't move on until it is done
- `status` (text): Where it stands, such as OPEN or ASSIGNED

**Example output**

```json
{
  "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**

- Incident (`incident`, text, required): The incident's ID, from another OneTrust step or the trigger, or a link to it in OneTrust.
- Stage (`stage`, text, required): The stage to move it to, by its name.

**Outputs**

- `id` (text): The incident's ID
- `stage` (text): The stage it is in now
- `stage_id` (text): That stage's ID

**Example output**

```json
{
  "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**

- Request (`request`, text, required): The request's 10-character ID, such as SL244HWD6D, from another OneTrust step or the trigger.
- Stage (`stage`, text, required): The stage to move it to.
- Resolution (`resolution`, text): Why it is rejected. Only when Stage is `REJECTED`.
- Comment (`comment`, text): A note on why it is rejected. Only when Stage is `REJECTED`.
- Comment for your team only (`internal_comment`, true/false): Keep the comment out of the person's privacy portal. Only when Stage is `REJECTED`. Default: `true`.

**Outputs**

- `id` (text): The request's 10-character ID
- `stage` (text): The stage it is in now

**Example output**

```json
{
  "id": "SL244HWD6D",
  "stage": "IN_PROGRESS"
}
```

### Create incident

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

**Inputs**

- Name (`name`, text, required): What happened, in a few words.
- Type (`incident_type`, text): The kind of incident. Leave blank for Unknown.
- Description (`description`, text): What happened.
- Organization (`organization`, text): The organization it belongs to. Leave blank for the one the connection's client credential was made in.
- Occurred (`occurred_at`, date and time): When it happened.
- Discovered (`discovered_at`, date and time): When it was discovered.
- Deadline (`deadline`, date and time): When the investigation or notice is due.
- Root cause (`root_cause`, text): Why it happened.
- Notice needed (`notification_needed`, text): Whether regulators or people must be told. One of: `YES`, `NO`, `UNKNOWN` (Not known yet).

**Outputs**

- `assignee` (text): Who it is assigned to
- `closed_at` (text): When it was closed (ISO 8601); empty if open
- `created_at` (text): When it was logged (ISO 8601)
- `created_by` (text): Who logged it
- `deadline` (text): When the investigation or notice is due (ISO 8601)
- `description` (text): What happened
- `discovered_at` (text): When it was discovered (ISO 8601)
- `id` (text): The incident's ID
- `incident_type` (text): Its type, such as Misdirected Email
- `name` (text): Its name
- `notification_needed` (text): YES, NO or UNKNOWN
- `number` (number): Its number in the incident register
- `occurred_at` (text): When it happened (ISO 8601)
- `organization` (text): The organization it belongs to
- `organization_id` (text): That organization's ID
- `root_cause` (text): Its root cause
- `stage` (text): The workflow stage it is in, such as Investigating
- `status` (text): OPEN or CLOSED
- `updated_at` (text): When it last changed (ISO 8601); empty in searches

**Example output**

```json
{
  "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**

- Type (`record_type`, text, required): What kind of inventory record it is. One of: `assets`, `processing-activities` (Processing activities), `vendors`, `entities` (Legal entities).
- Name (`name`, text, required): What the record is called.
- Location (`location`, text): Where the asset is hosted, or where the legal entity mainly operates. Only when Type is Assets or Legal entities.
- Vendor type (`vendor_type`, text): What kind of vendor it is. Only when Type is Vendors.
- Organization (`organization`, text): The organization it belongs to. Leave blank for the one the connection's client credential was made in.
- Other fields (`fields`, object): More of the record's fields, by their key in OneTrust, such as {"description": "Hosts the CRM"}.

**Outputs**

- `created_at` (text): When it was added (ISO 8601)
- `external_id` (text): Its ID in another system; empty if none
- `id` (text): The record's ID
- `link` (text): A link to it in OneTrust; empty if OneTrust didn't say
- `location` (text): Where an asset is hosted, or a legal entity operates
- `name` (text): Its name
- `number` (number): Its number in OneTrust
- `organization` (text): The organization it belongs to
- `organization_id` (text): That organization's ID
- `record_type` (text): assets, processing-activities, vendors or entities
- `risk_level` (text): Its risk level, such as HIGH; empty if not scored
- `risk_score` (number): Its risk score; 0 if not scored
- `select_fields` (object): Its choice fields, by their key, each a list of the values chosen
- `status` (text): Its status, such as active
- `text_fields` (object): Its text fields, by their key
- `updated_at` (text): When it last changed (ISO 8601)
- `vendor_type` (text): A vendor's type, such as Technology

**Example output**

```json
{
  "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 form (`web_form`, text, required): The web form the request is made through. Its ID ends the address of the form's page in OneTrust.
- Email (`email`, text, required): The person's email address.
- First name (`first_name`, text, required): The person's first name.
- Last name (`last_name`, text): The person's last name.
- Request types (`request_types`, list): What they ask for, as the web form names it, such as Delete Data.
- Subject types (`subject_types`, list): Who they are to you, as the web form names it, such as Customer.
- Language (`language`, text): 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 fields (`fields`, object): Answers to the web form's other fields, by their key, such as {"requestDetails": "Please delete my account"}.

**Outputs**

- `approver` (text): Who the request is assigned to
- `approver_email` (text): Their email; empty in lists
- `completed_at` (text): When it was completed (ISO 8601); empty if open
- `country` (text): The person's country
- `country_code` (text): The person's country code, such as US
- `created_at` (text): When it was submitted (ISO 8601)
- `days_left` (number): Days left until the deadline
- `deadline` (text): When it must be answered by (ISO 8601)
- `email` (text): The person's email
- `extended` (true/false): Whether the deadline was extended
- `fields` (object): The request's form fields, by their key, as OneTrust gives them
- `first_name` (text): The person's first name
- `id` (text): The request's 10-character ID, such as SL244HWD6D
- `language` (text): The request's language code, such as en-us
- `last_name` (text): The person's last name
- `organization` (text): The organization the request belongs to
- `request_types` (list): What the person asked for, such as Data Portability
- `resolution` (text): The resolution it was closed or rejected with
- `stage` (text): The workflow stage it is in, such as NEW or IN_PROGRESS
- `subject_types` (list): Who the person is to you, such as Customer
- `updated_at` (text): When it last changed (ISO 8601)
- `uuid` (text): The request's long ID (a UUID)
- `web_form` (text): The web form it came in through
- `web_form_id` (text): That web form's ID
- `workflow` (text): The request workflow it follows

**Example output**

```json
{
  "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**

- Type (`record_type`, text, required): What kind of inventory record it is. One of: `assets`, `processing-activities` (Processing activities), `vendors`, `entities` (Legal entities).
- Record (`record`, text, required): The record's ID, from another OneTrust step or the trigger, or a link to it in OneTrust.
- Delete for good (`permanently`, true/false): Delete it for good, rather than marking it deleted. Default: `false`.
- Reason (`reason`, text): Why it is deleted, kept for the audit trail.

**Outputs**

- `deleted` (true/false): Whether OneTrust deleted it
- `id` (text): The record's ID
- `permanently` (true/false): Whether it is gone for good rather than marked deleted
- `record_type` (text): Its type

**Example output**

```json
{
  "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**

- Request (`request`, text, required): The request's 10-character ID, such as SL244HWD6D, from another OneTrust step or the trigger.

**Outputs**

- `deleted` (true/false): Whether OneTrust deleted it
- `id` (text): The request's 10-character ID

**Example output**

```json
{
  "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**

- Search (`search`, text): Words to look for, such as laptop.
- How many (`limit`, number): The most to list. Defaults to 25. From 1 to 500.

**Outputs**

- `count` (number): How many are listed
- `incidents` (list): The incidents found
- `total` (number): How many match in all

**Example output**

```json
{
  "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**

- Search (`search`, text, required): A name, email or request ID, such as ada@example.com.
- Submitted since (`created_since`, date): Only requests submitted on or after this day.
- How many (`limit`, number): The most to list. Defaults to 25. From 1 to 500.

**Outputs**

- `count` (number): How many are listed
- `requests` (list): The requests found
- `total` (number): How many match in all

**Example output**

```json
{
  "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**

- Assessment (`assessment`, text, required): The assessment's ID, from another OneTrust step or the trigger, or a link to it in OneTrust.

**Outputs**

- `answers` (list): Every question and its answer
- `approvers` (list): Who approves it, and where each stands
- `completed_at` (text): When it was completed (ISO 8601)
- `created_at` (text): When it was launched (ISO 8601)
- `created_by` (text): Who launched it
- `deadline` (text): When it is due (ISO 8601); empty if no deadline
- `description` (text): Its description
- `id` (text): The assessment's ID
- `name` (text): Its name
- `number` (number): Its number in OneTrust
- `open_risks` (number): How many of its risks are open
- `organization` (text): The organization it belongs to
- `respondents` (list): Who answers it
- `result` (text): Its result once reviewed, such as Approved
- `risk_level` (text): Its overall risk level, such as LOW
- `status` (text): NOT_STARTED, IN_PROGRESS, UNDER_REVIEW or COMPLETED
- `submitted_at` (text): When it was submitted for review (ISO 8601)
- `template` (text): The template it was launched from
- `total_risks` (number): How many risks it found
- `updated_at` (text): When it last changed (ISO 8601)

**Example output**

```json
{
  "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 consent

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

**Inputs**

- Person (`identifier`, text, required): The person's identifier in OneTrust's consent records, usually their email.

**Outputs**

- `count` (number): How many purposes are listed
- `found` (true/false): Whether OneTrust has consent records for them
- `identifier` (text): The person's identifier, such as their email
- `purposes` (list): Their consent for each purpose

**Example output**

```json
{
  "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**

- Incident (`incident`, text, required): The incident's ID, from another OneTrust step or the trigger, or a link to it in OneTrust.

**Outputs**

- `assignee` (text): Who it is assigned to
- `closed_at` (text): When it was closed (ISO 8601); empty if open
- `created_at` (text): When it was logged (ISO 8601)
- `created_by` (text): Who logged it
- `deadline` (text): When the investigation or notice is due (ISO 8601)
- `description` (text): What happened
- `discovered_at` (text): When it was discovered (ISO 8601)
- `id` (text): The incident's ID
- `incident_type` (text): Its type, such as Misdirected Email
- `name` (text): Its name
- `notification_needed` (text): YES, NO or UNKNOWN
- `number` (number): Its number in the incident register
- `occurred_at` (text): When it happened (ISO 8601)
- `organization` (text): The organization it belongs to
- `organization_id` (text): That organization's ID
- `root_cause` (text): Its root cause
- `stage` (text): The workflow stage it is in, such as Investigating
- `status` (text): OPEN or CLOSED
- `updated_at` (text): When it last changed (ISO 8601); empty in searches

**Example output**

```json
{
  "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**

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

**Outputs**

- `created_at` (text): When it was added (ISO 8601)
- `external_id` (text): Its ID in another system; empty if none
- `id` (text): The record's ID
- `link` (text): A link to it in OneTrust; empty if OneTrust didn't say
- `location` (text): Where an asset is hosted, or a legal entity operates
- `name` (text): Its name
- `number` (number): Its number in OneTrust
- `organization` (text): The organization it belongs to
- `organization_id` (text): That organization's ID
- `record_type` (text): assets, processing-activities, vendors or entities
- `risk_level` (text): Its risk level, such as HIGH; empty if not scored
- `risk_score` (number): Its risk score; 0 if not scored
- `select_fields` (object): Its choice fields, by their key, each a list of the values chosen
- `status` (text): Its status, such as active
- `text_fields` (object): Its text fields, by their key
- `updated_at` (text): When it last changed (ISO 8601)
- `vendor_type` (text): A vendor's type, such as Technology

**Example output**

```json
{
  "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**

- Request (`request`, text, required): The request's 10-character ID, such as SL244HWD6D, from another OneTrust step or the trigger.

**Outputs**

- `approver` (text): Who the request is assigned to
- `approver_email` (text): Their email; empty in lists
- `comments` (list): Comments on the request
- `completed_at` (text): When it was completed (ISO 8601); empty if open
- `country` (text): The person's country
- `country_code` (text): The person's country code, such as US
- `created_at` (text): When it was submitted (ISO 8601)
- `days_left` (number): Days left until the deadline
- `deadline` (text): When it must be answered by (ISO 8601)
- `email` (text): The person's email
- `extended` (true/false): Whether the deadline was extended
- `fields` (object): The request's form fields, by their key, as OneTrust gives them
- `first_name` (text): The person's first name
- `id` (text): The request's 10-character ID, such as SL244HWD6D
- `language` (text): The request's language code, such as en-us
- `last_name` (text): The person's last name
- `organization` (text): The organization the request belongs to
- `request_types` (list): What the person asked for, such as Data Portability
- `resolution` (text): The resolution it was closed or rejected with
- `stage` (text): The workflow stage it is in, such as NEW or IN_PROGRESS
- `subject_types` (list): Who the person is to you, such as Customer
- `updated_at` (text): When it last changed (ISO 8601)
- `uuid` (text): The request's long ID (a UUID)
- `web_form` (text): The web form it came in through
- `web_form_id` (text): That web form's ID
- `workflow` (text): The request workflow it follows

**Example output**

```json
{
  "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**

- Template (`template`, text, required): The published template to launch it from.
- Name (`name`, text, required): What the assessment is called.
- Respondents (`respondents`, list, required): The emails of the people who answer it.
- Description (`description`, text): What it is about.
- Due (`deadline`, date and time): When it must be finished.
- Remind days before (`reminder_days`, number): How many days before the deadline to remind respondents. From 1 to 365.
- Organization (`organization`, text): The organization it belongs to. Leave blank for the one the connection's client credential was made in.

**Outputs**

- `id` (text): The new assessment's ID
- `name` (text): Its name
- `template_id` (text): The template it was launched from

**Example output**

```json
{
  "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**

- Statuses (`statuses`, list): 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`.
- Kinds (`template_types`, list): 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 many (`limit`, number): The most to list. Defaults to 25. From 1 to 500.

**Outputs**

- `assessments` (list): The assessments found
- `count` (number): How many are listed
- `total` (number): How many match in all

**Example output**

```json
{
  "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**

- Type (`record_type`, text, required): What kind of inventory record it is. One of: `assets`, `processing-activities` (Processing activities), `vendors`, `entities` (Legal entities).
- Search (`search`, text): Words in the record, such as its name.
- Page (`page`, number): Which page of results to list. Defaults to the first. From 1 to 10000.
- How many (`limit`, number): The most to list. Defaults to 25. From 1 to 50.

**Outputs**

- `count` (number): How many are listed
- `records` (list): The records found
- `total` (number): How many match in all

**Example output**

```json
{
  "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 retired (`include_retired`, true/false): List retired purposes too. Default: `false`.
- How many (`limit`, number): The most to list. Defaults to 25. From 1 to 100.

**Outputs**

- `count` (number): How many are listed
- `purposes` (list): The purposes
- `total` (number): How many match in all

**Example output**

```json
{
  "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**

- Stage (`stage`, text): Only requests in this stage. Leave blank for every stage.
- Submitted since (`created_since`, date): Only requests submitted on or after this day.
- Changed since (`updated_since`, date): Only requests changed on or after this day.
- How many (`limit`, number): The most to list. Defaults to 25. From 1 to 500.

**Outputs**

- `count` (number): How many are listed
- `requests` (list): The requests found
- `total` (number): How many match in all

**Example output**

```json
{
  "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 consent

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 point (`collection_point`, text, required): The collection point of the API kind the consent is recorded through.
- Person (`identifier`, text, required): The person's identifier in OneTrust's consent records, usually their email.
- Purposes (`purposes`, list, required): The purposes the choice is for, at most 20.
- Choice (`consent`, text): What the person chose. One of: `CONFIRMED` (Gave consent), `NO_CHOICE` (Made no choice), `OPT_OUT` (Opted out), `WITHDRAWN` (Withdrew consent). Default: `CONFIRMED`.
- Test record (`test`, true/false): Mark the person as a test record. This can't be undone. Default: `false`.

**Outputs**

- `consent` (text): What was recorded, such as CONFIRMED
- `identifier` (text): The person's identifier
- `link_token` (text): A token for the person's preference center; often empty
- `purposes` (list): The purposes it was recorded for
- `receipt` (text): OneTrust's receipt for it, a signed token

**Example output**

```json
{
  "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**

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

**Outputs**

- `created_at` (text): When it was added (ISO 8601)
- `external_id` (text): Its ID in another system; empty if none
- `id` (text): The record's ID
- `link` (text): A link to it in OneTrust; empty if OneTrust didn't say
- `location` (text): Where an asset is hosted, or a legal entity operates
- `name` (text): Its name
- `number` (number): Its number in OneTrust
- `organization` (text): The organization it belongs to
- `organization_id` (text): That organization's ID
- `record_type` (text): assets, processing-activities, vendors or entities
- `risk_level` (text): Its risk level, such as HIGH; empty if not scored
- `risk_score` (number): Its risk score; 0 if not scored
- `select_fields` (object): Its choice fields, by their key, each a list of the values chosen
- `status` (text): Its status, such as active
- `text_fields` (object): Its text fields, by their key
- `updated_at` (text): When it last changed (ISO 8601)
- `vendor_type` (text): A vendor's type, such as Technology

**Example output**

```json
{
  "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**

- Request (`request`, text, required): The request's 10-character ID, such as SL244HWD6D, from another OneTrust step or the trigger.
- Fields (`fields`, object, required): The fields to change, by their key, with their new values, such as {"requestDetails": "Account closed in March"}.

**Outputs**

- `approver` (text): Who the request is assigned to
- `approver_email` (text): Their email; empty in lists
- `completed_at` (text): When it was completed (ISO 8601); empty if open
- `country` (text): The person's country
- `country_code` (text): The person's country code, such as US
- `created_at` (text): When it was submitted (ISO 8601)
- `days_left` (number): Days left until the deadline
- `deadline` (text): When it must be answered by (ISO 8601)
- `email` (text): The person's email
- `extended` (true/false): Whether the deadline was extended
- `fields` (object): The request's form fields, by their key, as OneTrust gives them
- `first_name` (text): The person's first name
- `id` (text): The request's 10-character ID, such as SL244HWD6D
- `language` (text): The request's language code, such as en-us
- `last_name` (text): The person's last name
- `organization` (text): The organization the request belongs to
- `request_types` (list): What the person asked for, such as Data Portability
- `resolution` (text): The resolution it was closed or rejected with
- `stage` (text): The workflow stage it is in, such as NEW or IN_PROGRESS
- `subject_types` (list): Who the person is to you, such as Customer
- `updated_at` (text): When it last changed (ISO 8601)
- `uuid` (text): The request's long ID (a UUID)
- `web_form` (text): The web form it came in through
- `web_form_id` (text): That web form's ID
- `workflow` (text): The request workflow it follows

**Example output**

```json
{
  "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 consent

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

**Inputs**

- Person (`identifier`, text, required): The person's identifier in OneTrust's consent records, usually their email.
- Purpose (`purpose`, text, required): The purpose to withdraw their consent from.
- Notes (`notes`, text): Why, kept with the withdrawal.
- Withdrawn by (`withdrawn_by`, text): Who is withdrawing it, kept with the withdrawal. Defaults to Lodol.

**Outputs**

- `identifier` (text): The person's identifier
- `purpose_id` (text): The purpose consent was withdrawn from
- `status` (text): OneTrust's answer

**Example output**

```json
{
  "identifier": "ada@example.com",
  "purpose_id": "f2229953-b4b5-4042-8cb9-b78038cc4c46",
  "status": "Consent withdrawn successfully"
}
```
