# Drata

> Read compliance evidence, controls, frameworks, risks and audits in Drata, and manage asset inventory.

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

## Actions

### Create asset

Manually add a new Asset to the Account.

**Inputs**

- Name (`name`, text, required): The Asset name
- Description (`description`, text, required): The Asset description
- Notes (`notes`, text): The Asset notes
- Asset class types (`asset_class_types`, list, required): The Asset class types. One or more of: `HARDWARE`, `POLICY`, `DOCUMENT`, `PERSONNEL`, `SOFTWARE`, `CODE`, `CONTAINER`, `COMPUTE`, `NETWORKING`, `DATABASE`, `STORAGE`.
- Asset type (`asset_type`, text, required): The Asset type. One of: `PHYSICAL`, `VIRTUAL`.
- Owner (`owner_id`, number, required): The owner ID. At least 1.
- Associated ID (`associated_id`, text): An ID associated with this Asset
- Removed at (`removed_at`, date and time): Date the Asset was removed
- External ID (`external_id`, text): An externally sourced unique identifier for a virtual Asset
- External owner ID (`external_owner_id`, text): Used to track the source of virtual Assets, typically an account ID
- Custom fields (`custom_fields`, list): Custom Fields for the Asset. 💎 Requires your account have the Custom Fields and Formulas feature. Contact your Account Manager for help upgrading.

**Outputs**: Result.

- `data` (object): The complete service response; record and list fields retain their API names.
- `has_more` (true/false): Whether the API reports another page.
- `next_cursor` (text): Pass to the pagination field for the next page, when Has more is true.

**Example output**

```json
{
  "data": {
    "assetClassTypes": [],
    "assetProvider": "example",
    "assetReferenceType": null,
    "assetType": "example",
    "associatedId": null,
    "createdAt": "example",
    "customFields": [],
    "description": "example",
    "device": null,
    "externalId": null,
    "externalOwnerId": null,
    "id": 0,
    "name": "example",
    "notes": null,
    "owner": {
      "avatarUrl": null,
      "backgroundChecks": null,
      "createdAt": "example",
      "documents": [],
      "drataTermsAgreedAt": null,
      "email": "example",
      "firstName": null,
      "id": 0,
      "identities": [],
      "jobTitle": null,
      "lastName": null,
      "roles": [],
      "updatedAt": "example"
    },
    "removedAt": null,
    "updatedAt": "example"
  },
  "has_more": false,
  "next_cursor": null
}
```

### Delete asset

Remove a virtual or manually-added Asset.

**Inputs**

- Asset ID (`asset_id`, number, required): Asset id. At least 1.

**Outputs**: Result.

- `data` (null): The complete service response; record and list fields retain their API names.
- `has_more` (true/false): Whether the API reports another page.
- `next_cursor` (text): Pass to the pagination field for the next page, when Has more is true.

**Example output**

```json
{
  "data": null,
  "has_more": false,
  "next_cursor": null
}
```

### Get asset

Get asset for your connected Drata account.

**Inputs**

- Asset ID (`asset_id`, number, required): Asset id. At least 1.
- Expand (`expand`, list): List of subcollections and sub-objects to expand. One or more of: `device`, `assetClassTypes`, `complianceChecks`, `customFields`, `identifiers`, `owner`.

**Outputs**: Result.

- `data` (object): The complete service response; record and list fields retain their API names.
- `has_more` (true/false): Whether the API reports another page.
- `next_cursor` (text): Pass to the pagination field for the next page, when Has more is true.

**Example output**

```json
{
  "data": {
    "assetClassTypes": [],
    "assetProvider": "example",
    "assetReferenceType": null,
    "assetType": "example",
    "associatedId": null,
    "createdAt": "example",
    "customFields": [],
    "description": "example",
    "device": null,
    "externalId": null,
    "externalOwnerId": null,
    "id": 0,
    "name": "example",
    "notes": null,
    "owner": {
      "avatarUrl": null,
      "backgroundChecks": null,
      "createdAt": "example",
      "documents": [],
      "drataTermsAgreedAt": null,
      "email": "example",
      "firstName": null,
      "id": 0,
      "identities": [],
      "jobTitle": null,
      "lastName": null,
      "roles": [],
      "updatedAt": "example"
    },
    "removedAt": null,
    "updatedAt": "example"
  },
  "has_more": false,
  "next_cursor": null
}
```

### Get audit

Get audit for your connected Drata account.

**Inputs**

- Expand (`expand`, list): List of subcollections and sub-objects to expand. One or more of: `auditors`, `internalAuditors`, `controls`.
- Workspace (`workspace_id`, number, required): The Workspace ID associated to the Account. At least 1.
- Audit ID (`audit_id`, text, required): Audit id.

**Outputs**: Result.

- `data` (object): The complete service response; record and list fields retain their API names.
- `has_more` (true/false): Whether the API reports another page.
- `next_cursor` (text): Pass to the pagination field for the next page, when Has more is true.

**Example output**

```json
{
  "data": {
    "auditType": "example",
    "auditors": [],
    "completedAt": null,
    "controls": [],
    "createdAt": "example",
    "endDate": "example",
    "frameworkType": "example",
    "id": "example",
    "internalAuditors": [],
    "isInternalAudit": false,
    "startDate": "example",
    "status": "example",
    "updatedAt": "example"
  },
  "has_more": false,
  "next_cursor": null
}
```

### Get company

Get company for your connected Drata account.

**Inputs**: None.

**Outputs**: Result.

- `data` (object): The complete service response; record and list fields retain their API names.
- `has_more` (true/false): Whether the API reports another page.
- `next_cursor` (text): Pass to the pagination field for the next page, when Has more is true.

**Example output**

```json
{
  "data": {
    "accountId": "example",
    "agentEnabled": false,
    "backgroundCheck": null,
    "createdAt": "example",
    "description": null,
    "domain": "example",
    "entitlements": [],
    "hipaaTraining": null,
    "language": "example",
    "legalName": null,
    "logoUrl": null,
    "manualUploadEnabled": false,
    "name": "example",
    "securityTraining": null,
    "updatedAt": "example"
  },
  "has_more": false,
  "next_cursor": null
}
```

### Get control

Get all the information for a specific Control. Requires the Controls: Get Control permission.

**Inputs**

- Workspace (`workspace_id`, number, required): The Workspace ID associated to the Account. At least 1.
- Cursor (`cursor`, text): This parameter is used to paginate through results. No value is needed for the first request. If there are additional results, the response will contain a `pagination.cursor` value that can be used in the subsequent request to retrieve the next page of results
- Size (`size`, number): Number of results to return. From 1 to 500.
- Sort (`sort`, text): Which field to sort by. One of: `createdAt`, `updatedAt`.
- Sort dir (`sort_dir`, text): The direction to sort the data. One of: `ASC`, `DESC`.
- Expand (`expand`, list): List of subcollections and sub-objects to expand. One or more of: `customFields`, `evidenceIds`, `flags`, `frameworkTags`, `owners`, `requirements`, `testIds`, `topics`.
- Control ID (`control_id`, number, required): An integer control ID or a control code prefixed with `code:`. At least 1.

**Outputs**: Result.

- `data` (object): The complete service response; record and list fields retain their API names.
- `has_more` (true/false): Whether the API reports another page.
- `next_cursor` (text): Pass to the pagination field for the next page, when Has more is true.

**Example output**

```json
{
  "data": {
    "activity": null,
    "archivedAt": null,
    "code": "example",
    "controlTemplateId": null,
    "createdAt": "example",
    "customFields": [],
    "description": null,
    "evidenceIds": {
      "invalidExternalEvidenceIds": [],
      "invalidReportIds": [],
      "validExternalEvidenceIds": [],
      "validReportIds": []
    },
    "flags": {
      "hasEvidence": null,
      "hasOwner": false,
      "hasPolicy": null,
      "hasTicket": null,
      "isMonitored": false,
      "isReady": null
    },
    "frameworkTags": [],
    "id": 0,
    "name": "example",
    "owners": {
      "data": [],
      "totalCount": 0
    },
    "question": null,
    "rationale": null,
    "requirements": [],
    "slug": null,
    "testIds": {
      "failing": [],
      "monitored": [],
      "passing": []
    },
    "topics": [],
    "updatedAt": "example"
  },
  "has_more": false,
  "next_cursor": null
}
```

### Get device

Get device for your connected Drata account.

**Inputs**

- Device ID (`device_id`, number, required): The device ID. At least 1.
- Expand (`expand`, list): List of subcollections and sub-objects to expand. One or more of: `asset`, `complianceChecks`, `documents`, `identifiers`, `deviceApps`.

**Outputs**: Result.

- `data` (object): The complete service response; record and list fields retain their API names.
- `has_more` (true/false): Whether the API reports another page.
- `next_cursor` (text): Pass to the pagination field for the next page, when Has more is true.

**Example output**

```json
{
  "data": {
    "antivirusEnabled": null,
    "antivirusExplanation": null,
    "apps": [],
    "appsCount": null,
    "asset": null,
    "assetId": null,
    "autoUpdateEnabled": null,
    "autoUpdateExplanation": null,
    "complianceChecks": [],
    "createdAt": "example",
    "deletedAt": null,
    "documents": [],
    "encryptionEnabled": null,
    "encryptionExplanation": null,
    "externalId": null,
    "firewallEnabled": null,
    "firewallExplanation": null,
    "id": 0,
    "identifiers": [],
    "isDeviceCompliant": false,
    "lastCheckedAt": null,
    "macAddress": null,
    "model": null,
    "osVersion": null,
    "passwordManagerEnabled": null,
    "passwordManagerExplanation": null,
    "personnelId": 0,
    "screenLockExplanation": null,
    "screenLockTime": null,
    "serialNumber": null,
    "sourceType": "example",
    "updatedAt": "example",
    "userId": null
  },
  "has_more": false,
  "next_cursor": null
}
```

### Get event

Get details for an Event.

**Inputs**

- Event ID (`event_id`, text, required): Event id.
- Cursor (`cursor`, text): This parameter is used to paginate through results. No value is needed for the first request. If there are additional results, the response will contain a `pagination.cursor` value that can be used in the subsequent request to retrieve the next page of results
- Size (`size`, number): Number of results to return. From 1 to 500.
- Sort (`sort`, text): Which field to sort by. One of: `createdAt`, `updatedAt`.
- Sort dir (`sort_dir`, text): The direction to sort the data. One of: `ASC`, `DESC`.
- Expand (`expand`, list): List of subcollections and sub-objects to expand. One or more of: `connection`, `issues`, `metadata`, `testId`, `testName`, `user`.

**Outputs**: Result.

- `data` (object): The complete service response; record and list fields retain their API names.
- `has_more` (true/false): Whether the API reports another page.
- `next_cursor` (text): Pass to the pagination field for the next page, when Has more is true.

**Example output**

```json
{
  "data": {
    "category": "example",
    "connection": null,
    "connectionId": null,
    "createdAt": "example",
    "description": "example",
    "id": "example",
    "issues": [],
    "metadata": {
      "dto": null,
      "fileKey": null,
      "request": null,
      "response": null,
      "sourceData": null,
      "targetEntities": [],
      "targetEntity": null,
      "taskType": null
    },
    "requestDescription": null,
    "source": "example",
    "status": null,
    "testId": null,
    "testName": null,
    "type": "example",
    "user": null,
    "userId": null
  },
  "has_more": false,
  "next_cursor": null
}
```

### Get evidence

Get a specific evidence item by ID with optional expand.

**Inputs**

- Workspace (`workspace_id`, number, required): The Workspace ID associated to the Account. At least 1.
- Evidence ID (`evidence_id`, number, required): Evidence id. At least 1.
- Expand (`expand`, list): List of subcollections and sub-objects to expand. One or more of: `owners`, `artifacts`, `controls`.

**Outputs**: Result.

- `data` (object): The complete service response; record and list fields retain their API names.
- `has_more` (true/false): Whether the API reports another page.
- `next_cursor` (text): Pass to the pagination field for the next page, when Has more is true.

**Example output**

```json
{
  "data": {
    "artifacts": {
      "data": [],
      "totalCount": 0
    },
    "controls": {
      "data": [],
      "totalCount": 0
    },
    "createdAt": "example",
    "description": null,
    "evidenceTemplateCode": null,
    "id": 0,
    "implementationGuidance": null,
    "name": "example",
    "owners": {
      "data": [],
      "totalCount": 0
    },
    "renewalDate": null,
    "renewalScheduleType": null,
    "safeBaseSyncStatus": null,
    "status": "example",
    "updatedAt": "example"
  },
  "has_more": false,
  "next_cursor": null
}
```

### Get person

Get a single Personnel record.

**Inputs**

- Expand (`expand`, list): List of subcollections and sub-objects to expand. One or more of: `customFields`, `complianceChecks`, `reasonProvider`, `user`.
- Personnel ID (`personnel_id`, number, required): An integer Personnel ID or User's email address prefixed with `email:`. At least 1.

**Outputs**: Result.

- `data` (object): The complete service response; record and list fields retain their API names.
- `has_more` (true/false): Whether the API reports another page.
- `next_cursor` (text): Pass to the pagination field for the next page, when Has more is true.

**Example output**

```json
{
  "data": {
    "complianceChecks": [],
    "createdAt": "example",
    "customFields": [],
    "employmentStatus": "example",
    "id": 0,
    "notHumanReason": null,
    "reasonProvider": null,
    "separatedAt": null,
    "startedAt": null,
    "statusUpdatedAt": null,
    "updatedAt": "example",
    "user": {
      "createdAt": "example",
      "email": "example",
      "firstName": null,
      "id": 0,
      "lastName": null,
      "updatedAt": "example"
    },
    "userId": 0
  },
  "has_more": false,
  "next_cursor": null
}
```

### Get vendor

Get vendor for your connected Drata account.

**Inputs**

- Vendor ID (`vendor_id`, number, required): Vendor id. At least 1.
- Expand (`expand`, list): List of subcollections and sub-objects to expand. One or more of: `customFields`, `documents`, `integrations`, `lastQuestionnaire`, `latestSecurityReviews`, `reviews`, `vendorUser`, `vendorRelationshipContact`, `dataAccessedOrProcessed`, `scheduleConfiguration`, and 3 more.

**Outputs**: Result.

- `data` (object): The complete service response; record and list fields retain their API names.
- `has_more` (true/false): Whether the API reports another page.
- `next_cursor` (text): Pass to the pagination field for the next page, when Has more is true.

**Example output**

```json
{
  "data": {
    "_links": {
      "self": {
        "href": "example"
      }
    },
    "archivedAs": null,
    "archivedAt": null,
    "catalogProductCandidateId": null,
    "category": null,
    "confirmedAt": null,
    "contactAtVendor": null,
    "contactsEmail": null,
    "cost": null,
    "createdAt": "example",
    "critical": null,
    "customFields": [],
    "dataAccessedOrProcessedList": null,
    "dataStored": null,
    "documents": [],
    "environmentAccess": null,
    "events": null,
    "hasPii": false,
    "id": 0,
    "impactLevel": null,
    "inherentRiskLevel": null,
    "inherentRiskLevelId": null,
    "integrations": null,
    "isDrataUser": null,
    "isSubProcessor": false,
    "isSubProcessorActive": false,
    "lastQuestionnaire": null,
    "latestSecurityReviews": null,
    "location": null,
    "logoUrl": null,
    "name": "example",
    "notes": null,
    "operationalImpact": null,
    "passwordMfaEnabled": false,
    "passwordMinLength": null,
    "passwordPolicy": null,
    "passwordRequiresMinLength": false,
    "passwordRequiresNumber": false,
    "passwordRequiresSymbol": false,
    "privacyUrl": null,
    "renewalDate": null,
    "renewalDateStatus": null,
    "renewalScheduleType": null,
    "residualRiskLevel": null,
    "residualRiskLevelId": null,
    "reviews": [],
    "risk": null,
    "servicesProvided": null,
    "sharedAccountId": null,
    "status": null,
    "termsUrl": null,
    "trustCenterProvider": null,
    "trustCenterUrl": null,
    "type": null,
    "updatedAt": "example",
    "url": null,
    "user": null,
    "vendorRelationshipContact": null
  },
  "has_more": false,
  "next_cursor": null
}
```

### List assets

Find Assets by search terms and filters. Gets one page; to see more, run it again with the next page it gives.

**Inputs**

- Cursor (`cursor`, text): This parameter is used to paginate through results. No value is needed for the first request. If there are additional results, the response will contain a `pagination.cursor` value that can be used in the subsequent request to retrieve the next page of results
- Size (`size`, number): Number of results to return. From 1 to 500.
- Sort (`sort`, text): Which field to sort by. One of: `createdAt`, `updatedAt`.
- Sort dir (`sort_dir`, text): The direction to sort the data. One of: `ASC`, `DESC`.
- Include total count (`include_total_count`, true/false): Include total count of all matching records in response. Only honored on first page (when cursor is null).
- Expand (`expand`, list): List of subcollections and sub-objects to expand. One or more of: `device`, `assetClassTypes`, `complianceChecks`, `customFields`, `identifiers`, `owner`.
- Asset class type (`asset_class_type`, text): Filter assets by class type. This filter is only supported in conjunction with expand[]=assetClassTypes. One of: `HARDWARE`, `POLICY`, `DOCUMENT`, `PERSONNEL`, `SOFTWARE`, `CODE`, `CONTAINER`, `COMPUTE`, `NETWORKING`, `DATABASE`, `STORAGE`.
- Asset type (`asset_type`, text): Filter assets by type. One of: `PHYSICAL`, `VIRTUAL`.
- Asset provider (`asset_provider`, text): Filter assets by provider. One of: `DRATA_DEV`, `AGENT`, `DRATA`, `GOOGLE`, `MICROSOFT_365`, `JAMF`, `INTUNE`, `OKTA_IDENTITY`, `KANDJI`, `JUMPCLOUD`, and 18 more.
- Target user ID (`target_user_id`, number): Filter data by user ID associated to the Assets. From 1 to 1000000000.
- Employment status (`employment_status`, text): Filter data by personnel of this employment status. One of: `CURRENT_EMPLOYEE`, `FORMER_EMPLOYEE`, `CURRENT_CONTRACTOR`, `FORMER_CONTRACTOR`, `OUT_OF_SCOPE`, `UNKNOWN`, `SPECIAL_FORMER_EMPLOYEE`, `SPECIAL_FORMER_CONTRACTOR`, `FUTURE_HIRE`, `SERVICE_ACCOUNT`.

**Outputs**: Result.

- `data` (object): The complete service response; record and list fields retain their API names.
- `has_more` (true/false): Whether the API reports another page.
- `next_cursor` (text): Pass to the pagination field for the next page, when Has more is true.

**Example output**

```json
{
  "data": {
    "data": [],
    "pagination": {
      "cursor": null,
      "totalCount": null
    }
  },
  "has_more": false,
  "next_cursor": null
}
```

### List audits

List audits for your connected Drata account. Gets one page; to see more, run it again with the next page it gives.

**Inputs**

- Cursor (`cursor`, text): This parameter is used to paginate through results. No value is needed for the first request. If there are additional results, the response will contain a `pagination.cursor` value that can be used in the subsequent request to retrieve the next page of results
- Size (`size`, number): Number of results to return. From 1 to 500.
- Sort (`sort`, text): Which field to sort by. One of: `createdAt`, `updatedAt`.
- Sort dir (`sort_dir`, text): The direction to sort the data. One of: `ASC`, `DESC`.
- Expand (`expand`, list): List of subcollections and sub-objects to expand. One or more of: `auditors`, `internalAuditors`.
- Workspace (`workspace_id`, number, required): The Workspace ID associated to the Account. At least 1.

**Outputs**: Result.

- `data` (object): The complete service response; record and list fields retain their API names.
- `has_more` (true/false): Whether the API reports another page.
- `next_cursor` (text): Pass to the pagination field for the next page, when Has more is true.

**Example output**

```json
{
  "data": {
    "data": [],
    "pagination": {
      "cursor": null
    }
  },
  "has_more": false,
  "next_cursor": null
}
```

### List controls

Find Controls matching the provided filters. Gets one page; to see more, run it again with the next page it gives.

**Inputs**

- Workspace (`workspace_id`, number, required): The Workspace ID associated to the Account. At least 1.
- Cursor (`cursor`, text): This parameter is used to paginate through results. No value is needed for the first request. If there are additional results, the response will contain a `pagination.cursor` value that can be used in the subsequent request to retrieve the next page of results
- Size (`size`, number): Number of results to return. From 1 to 500.
- Sort (`sort`, text): Which field to sort by. One of: `createdAt`, `updatedAt`.
- Sort dir (`sort_dir`, text): The direction to sort the data. One of: `ASC`, `DESC`.
- Include total count (`include_total_count`, true/false): Include total count of all matching records in response. Only honored on first page (when cursor is null).
- Expand (`expand`, list): List of subcollections and sub-objects to expand. One or more of: `customFields`, `evidenceIds`, `flags`, `frameworkTags`, `owners`, `requirements`, `testIds`, `topics`.
- Is monitored (`is_monitored`, true/false): Filter Controls that have or do not have a Monitor
- Is ready (`is_ready`, true/false): Filter Controls that are or are not ready
- Has evidence (`has_evidence`, true/false): Filter to Controls with or without Evidence
- Has policy (`has_policy`, true/false): Filter to Controls with or without Policy
- Has passing test (`has_passing_test`, true/false): Filter to Controls with at least one passing Test
- Ticket status (`ticket_status`, text): Only include Controls with an associated Task Management Ticket. One of: `IN_PROGRESS`, `ARCHIVED`.
- Policy ID (`policy_id`, number): Filter Controls associated with a specific Policy ID. At least 1.
- Is enabled (`is_enabled`, true/false): Filter Controls that are or are not enabled
- Is archived (`is_archived`, true/false): Filter Controls that are or are not archived
- Required approvals (`required_approvals`, text): Filter Controls by the status of their required approval. CHANGES_REQUESTED, NEEDS_APPROVAL and PREPARE_FOR_APPROVERS identify Controls that are not ready because their approval is still in progress; APPROVED and NO_REVIEW do not block readiness. Approval status only applies to enabled Controls, so this filter cannot be combined with isEnabled=false. One of: `PREPARE_FOR_APPROVERS`, `NEEDS_APPROVAL`, `APPROVED`, `CHANGES_REQUESTED`, `NO_REVIEW`.

**Outputs**: Result.

- `data` (object): The complete service response; record and list fields retain their API names.
- `has_more` (true/false): Whether the API reports another page.
- `next_cursor` (text): Pass to the pagination field for the next page, when Has more is true.

**Example output**

```json
{
  "data": {
    "data": [],
    "pagination": {
      "cursor": null,
      "totalCount": null
    }
  },
  "has_more": false,
  "next_cursor": null
}
```

### List devices

List devices for your connected Drata account. Gets one page; to see more, run it again with the next page it gives.

**Inputs**

- Cursor (`cursor`, text): This parameter is used to paginate through results. No value is needed for the first request. If there are additional results, the response will contain a `pagination.cursor` value that can be used in the subsequent request to retrieve the next page of results
- Size (`size`, number): Number of results to return. From 1 to 500.
- Sort (`sort`, text): Which field to sort by. One of: `createdAt`, `updatedAt`.
- Sort dir (`sort_dir`, text): The direction to sort the data. One of: `ASC`, `DESC`.
- Include total count (`include_total_count`, true/false): Include total count of all matching records in response. Only honored on first page (when cursor is null).
- External ID (`external_id`, text): An externally sourced unique identifier for a device
- Expand (`expand`, list): List of subcollections and sub-objects to expand. One or more of: `asset`, `complianceChecks`, `documents`, `identifiers`.
- Mac address (`mac_address`, text): The device MAC address
- Serial number (`serial_number`, text): The device serial number
- Source type (`source_type`, text): Device source type. One of: `AGENT`, `JAMF`, `INTUNE`, `KANDJI`, `JUMPCLOUD`, `HEXNODE_UEM`, `UNKNOWN`, `RIPPLING`, `WORKSPACE_ONE`, `KOLIDE`, and 4 more.
- Personnel ID (`personnel_id`, number): Personnel ID. At least 1.

**Outputs**: Result.

- `data` (object): The complete service response; record and list fields retain their API names.
- `has_more` (true/false): Whether the API reports another page.
- `next_cursor` (text): Pass to the pagination field for the next page, when Has more is true.

**Example output**

```json
{
  "data": {
    "data": [],
    "pagination": {
      "cursor": null,
      "totalCount": null
    }
  },
  "has_more": false,
  "next_cursor": null
}
```

### List events

Find Events matching the provided filters. Gets one page; to see more, run it again with the next page it gives.

**Inputs**

- Cursor (`cursor`, text): This parameter is used to paginate through results. No value is needed for the first request. If there are additional results, the response will contain a `pagination.cursor` value that can be used in the subsequent request to retrieve the next page of results
- Size (`size`, number): Number of results to return. From 1 to 500.
- Sort (`sort`, text): Events can only be sorted by create date. One of: `createdAt`.
- Sort dir (`sort_dir`, text): The direction to sort the data. One of: `ASC`, `DESC`.
- Include total count (`include_total_count`, true/false): Include total count of all matching records in response. Only honored on first page (when cursor is null).
- Expand (`expand`, list): List of subcollections and sub-objects to expand. One or more of: `connection`, `issues`, `metadata`, `testId`, `testName`, `user`.
- Type (`type`, text): Filter data to events of this type. One of: `COMPANY_DATA_UPDATED`, `COMPANY_LOGO_UPDATED`, `COMPANY_KEY_PERSONNEL_UPDATED`, `COMPANY_ROLES_UPDATED`, `COMPANY_SECURITY_DATA_UPDATED`, `COMPANY_DOCUMENT_UPLOADED`, `COMPANY_DOCUMENT_DOWNLOADED`, `COMPANY_DOCUMENT_DELETED`, `COMPANY_HUMAN_RESOURCES_DATA_UPDATED`, `EMPLOYMENT_STATUS_UPDATED`, and 873 more.
- Source (`source`, text): Filter data to events of this source. One of: `APP`, `AUTOPILOT`, `PUBLIC_API`, `VENDOR_QUESTIONNAIRE`, `SCHEDULED`, `WORKFLOW`, `DRATA_POLICY`, `AUDIT_AGENT`.
- Category (`category`, text): Filter data to events of this category. One of: `AUTOPILOT`, `AGENT`, `POLICY`, `PERSONNEL`, `REPORT`, `VENDOR`, `ASSET`, `COMPANY`, `ASSESSMENT`, `AUDIT`, and 33 more.
- Drata connection ID (`drata_connection_id`, number): The connection to filter events by. A null/blank value will return events without a connection. At least 1.
- Target user ID (`target_user_id`, number): The user to filter events by. A null/blank value will return events without a user. At least 1.
- Workspace (`workspace_id`, number): The workspace to filter events to. At least 1.
- Created at start date (`created_at_start_date`, date and time): Filters the events to those with a creation date greater than or equal to this date and time.
- Created at end date (`created_at_end_date`, date and time): Filters the events to those with a creation date less than or equal to this date and time

**Outputs**: Result.

- `data` (object): The complete service response; record and list fields retain their API names.
- `has_more` (true/false): Whether the API reports another page.
- `next_cursor` (text): Pass to the pagination field for the next page, when Has more is true.

**Example output**

```json
{
  "data": {
    "data": [],
    "pagination": {
      "cursor": null,
      "totalCount": null
    }
  },
  "has_more": false,
  "next_cursor": null
}
```

### List evidence

List evidence items with pagination, filtering, and optional expand. Gets one page; to see more, run it again with the next page it gives.

**Inputs**

- Workspace (`workspace_id`, number, required): The Workspace ID associated to the Account. At least 1.
- Cursor (`cursor`, text): This parameter is used to paginate through results. No value is needed for the first request. If there are additional results, the response will contain a `pagination.cursor` value that can be used in the subsequent request to retrieve the next page of results
- Size (`size`, number): Number of results to return. From 1 to 500.
- Sort (`sort`, text): Which field to sort by. One of: `createdAt`, `updatedAt`.
- Sort dir (`sort_dir`, text): The direction to sort the data. One of: `ASC`, `DESC`.
- Expand (`expand`, list): List of subcollections and sub-objects to expand. One or more of: `owners`, `artifacts`, `controls`.
- Name (`name`, text): Filter evidence items by name (prefix match)
- Owner IDS (`owner_ids`, list): IDs of the users that own the evidence current version.
- Framework IDS (`framework_ids`, list): Array of Ids of frameworks to be used as filters
- Evidence statuses (`evidence_statuses`, list): Filter evidence items by statuses. One or more of: `NEEDS_ARTIFACT`, `EXPIRED`, `EXPIRING_SOON`, `TEST_ERROR`, `TEST_FAILED`, `READY`, `TEST_PASSED`, `TEST_UNUSED`, `TEST_DISABLED`, `TEST_DELETED`.
- Artifact types (`artifact_types`, list): Filter evidence items by artifact types. One or more of: `URL`, `S3_FILE`, `TICKET_PROVIDER`, `NONE`, `GOOGLE_DRIVE`, `ONE_DRIVE`, `BOX`, `DROPBOX`, `SHARE_POINT`, `TEST_RESULT`.

**Outputs**: Result.

- `data` (object): The complete service response; record and list fields retain their API names.
- `has_more` (true/false): Whether the API reports another page.
- `next_cursor` (text): Pass to the pagination field for the next page, when Has more is true.

**Example output**

```json
{
  "data": {
    "data": [],
    "pagination": {
      "cursor": null
    }
  },
  "has_more": false,
  "next_cursor": null
}
```

### List frameworks

Find Frameworks matching the provided filters. Gets one page; to see more, run it again with the next page it gives.

**Inputs**

- Workspace (`workspace_id`, number, required): The Workspace ID associated to the Account. At least 1.
- Cursor (`cursor`, text): This parameter is used to paginate through results. No value is needed for the first request. If there are additional results, the response will contain a `pagination.cursor` value that can be used in the subsequent request to retrieve the next page of results
- Size (`size`, number): Number of results to return. From 1 to 500.
- Sort (`sort`, text): Which field to sort by. One of: `createdAt`, `updatedAt`.
- Sort dir (`sort_dir`, text): The direction to sort the data. One of: `ASC`, `DESC`.
- Include total count (`include_total_count`, true/false): Include total count of all matching records in response. Only honored on first page (when cursor is null).
- Name (`name`, text): Filter Frameworks by name (partial match)
- Exclude IDS (`exclude_ids`, list): Array of Framework IDs to exclude from results
- Is ready (`is_ready`, true/false): Filter Frameworks by ready state
- Is enabled (`is_enabled`, true/false): Filter Frameworks by enabled state

**Outputs**: Result.

- `data` (object): The complete service response; record and list fields retain their API names.
- `has_more` (true/false): Whether the API reports another page.
- `next_cursor` (text): Pass to the pagination field for the next page, when Has more is true.

**Example output**

```json
{
  "data": {
    "data": [],
    "pagination": {
      "cursor": null,
      "totalCount": null
    }
  },
  "has_more": false,
  "next_cursor": null
}
```

### List monitoring tests

Find Monitoring Tests matching the provided filters. Requires the Monitoring: List Monitors permission. Gets one page; to see more, run it again with the next page it gives.

**Inputs**

- Workspace (`workspace_id`, number, required): The Workspace ID associated to the Account. At least 1.
- Cursor (`cursor`, text): This parameter is used to paginate through results. No value is needed for the first request. If there are additional results, the response will contain a `pagination.cursor` value that can be used in the subsequent request to retrieve the next page of results
- Size (`size`, number): Number of results to return. From 1 to 500.
- Sort (`sort`, text): Which field to sort by. One of: `createdAt`, `updatedAt`.
- Sort dir (`sort_dir`, text): The direction to sort the data. One of: `ASC`, `DESC`.
- Include total count (`include_total_count`, true/false): Include total count of all matching records in response. Only honored on first page (when cursor is null).
- Expand (`expand`, list): List of subcollections and sub-objects to expand. One or more of: `controls`, `monitorInstances`, `disablingUser`.
- Check result status (`check_result_status`, text): Filter Monitors by result status. One of: `READY`, `PASSED`, `FAILED`, `ERROR`, `PREAUDIT`.
- Check status (`check_status`, text): Filter Monitors by system status. One of: `UNUSED`, `NEW`, `ENABLED`, `DISABLED`, `TESTING`.
- Type (`type`, text): Filter Monitors by check type (associated monitor instances). One of: `POLICY`, `IN_DRATA`, `AGENT`, `INFRASTRUCTURE`, `VERSION_CONTROL`, `IDENTITY`, `TICKETING`, `HRIS`, `OBSERVABILITY`, `CUSTOM`.
- Test source (`test_source`, text): Filter monitors by test source type (DRATA for built-in tests, CUSTOM for user-created tests, ACORN for compliance-as-code tests, EXTERNAL for external tests, DRATA_LIBRARY for Drata library tests). One of: `DRATA`, `CUSTOM`, `EXTERNAL`, `ACORN`, `DRATA_LIBRARY`.

**Outputs**: Result.

- `data` (object): The complete service response; record and list fields retain their API names.
- `has_more` (true/false): Whether the API reports another page.
- `next_cursor` (text): Pass to the pagination field for the next page, when Has more is true.

**Example output**

```json
{
  "data": {
    "data": [],
    "pagination": {
      "cursor": null,
      "totalCount": null
    }
  },
  "has_more": false,
  "next_cursor": null
}
```

### List personnel

Get a paginated list of Personnel records. Gets one page; to see more, run it again with the next page it gives.

**Inputs**

- Cursor (`cursor`, text): This parameter is used to paginate through results. No value is needed for the first request. If there are additional results, the response will contain a `pagination.cursor` value that can be used in the subsequent request to retrieve the next page of results
- Size (`size`, number): Number of results to return. From 1 to 500.
- Sort (`sort`, text): Which field to sort by. One of: `createdAt`, `updatedAt`.
- Sort dir (`sort_dir`, text): The direction to sort the data. One of: `ASC`, `DESC`.
- Include total count (`include_total_count`, true/false): Include total count of all matching records in response. Only honored on first page (when cursor is null).
- Expand (`expand`, list): List of subcollections and sub-objects to expand. One or more of: `customFields`, `complianceChecks`, `reasonProvider`, `user`.
- Employment status (`employment_status`, list): Personnel by employment statuses. One or more of: `CURRENT_EMPLOYEE`, `FORMER_EMPLOYEE`, `CURRENT_CONTRACTOR`, `FORMER_CONTRACTOR`, `OUT_OF_SCOPE`, `UNKNOWN`, `SPECIAL_FORMER_EMPLOYEE`, `SPECIAL_FORMER_CONTRACTOR`, `FUTURE_HIRE`, `SERVICE_ACCOUNT`.
- Compliance status (`compliance_status`, list): Filter Personnel by overall compliance status. One or more of: `MISCONFIGURED`, `PASS`, `FAIL`, `EXCLUDED`, `NOT_ASSESSED`.

**Outputs**: Result.

- `data` (object): The complete service response; record and list fields retain their API names.
- `has_more` (true/false): Whether the API reports another page.
- `next_cursor` (text): Pass to the pagination field for the next page, when Has more is true.

**Example output**

```json
{
  "data": {
    "data": [],
    "pagination": {
      "cursor": null,
      "totalCount": null
    }
  },
  "has_more": false,
  "next_cursor": null
}
```

### List risk registers

Retrieve all Risk Registers associated with the account. Gets one page; to see more, run it again with the next page it gives.

**Inputs**

- Cursor (`cursor`, text): This parameter is used to paginate through results. No value is needed for the first request. If there are additional results, the response will contain a `pagination.cursor` value that can be used in the subsequent request to retrieve the next page of results
- Size (`size`, number): Number of results to return. From 1 to 500.
- Sort (`sort`, text): Which field to sort by. One of: `createdAt`, `updatedAt`.
- Sort dir (`sort_dir`, text): The direction to sort the data. One of: `ASC`, `DESC`.
- Include total count (`include_total_count`, true/false): Include total count of all matching records in response. Only honored on first page (when cursor is null).
- Name (`name`, text): Search query for Register name
- Owner IDS (`owner_ids`, list): User IDs of the Register Owners to filter by
- Workspace IDS (`workspace_ids`, list): Workspace IDs to filter Risk Registers by
- Expand (`expand`, list): List of subcollections and sub-objects to expand. One or more of: `workspaces`.

**Outputs**: Result.

- `data` (object): The complete service response; record and list fields retain their API names.
- `has_more` (true/false): Whether the API reports another page.
- `next_cursor` (text): Pass to the pagination field for the next page, when Has more is true.

**Example output**

```json
{
  "data": {
    "data": [],
    "pagination": {
      "cursor": null,
      "totalCount": null
    }
  },
  "has_more": false,
  "next_cursor": null
}
```

### List risks

Find Risks matching the provided filters. Gets one page; to see more, run it again with the next page it gives.

**Inputs**

- Risk register (`risk_register_id`, number, required): The Risk Register ID. At least 1.
- Cursor (`cursor`, text): This parameter is used to paginate through results. No value is needed for the first request. If there are additional results, the response will contain a `pagination.cursor` value that can be used in the subsequent request to retrieve the next page of results
- Size (`size`, number): Number of results to return. From 1 to 500.
- Sort (`sort`, text): Which field to sort by. One of: `createdAt`, `updatedAt`.
- Sort dir (`sort_dir`, text): The direction to sort the data. One of: `ASC`, `DESC`.
- Include total count (`include_total_count`, true/false): Include total count of all matching records in response. Only honored on first page (when cursor is null).
- Expand (`expand`, list): List of subcollections and sub-objects to expand. One or more of: `owners`, `reviewers`, `controls`, `categories`, `documents`, `notes`, `tickets`, `tasks`, `customFields`.
- Title (`title`, text): Filter Risks by title. Performs a case-insensitive partial match on the Risk title field.
- Status (`status`, text): Filter Risks by status. One of: `ACTIVE`, `ARCHIVED`, `CLOSED`.
- Treatment plan (`treatment_plan`, text): Filter Risks by their treatment strategy. Treatment plans define how the organization addresses each Risk: ACCEPT (acknowledge and monitor), AVOID (eliminate the Risk source), MITIGATE (reduce impact/likelihood), TRANSFER (shift to third party via insurance/contracts), or UNTREATED (no action taken yet). One of: `UNTREATED`, `ACCEPT`, `TRANSFER`, `AVOID`, `MITIGATE`.
- Min score (`min_score`, number): Filter Risks by minimum calculated Risk score (impact × likelihood). Score range depends on organization settings (1-25 with thresholds 1-4=low, 5-9=medium, 10-16=high, 17-25=critical). From 1 to 25.
- Max score (`max_score`, number): Filter Risks by maximum calculated Risk score (impact × likelihood). Score range depends on organization settings (1-25 with thresholds 1-4=low, 5-9=medium, 10-16=high, 17-25=critical). From 1 to 25.
- Vendor ID (`vendor_id`, number): Filter Risks by vendor/third-party provider. Specify the unique vendor identifier to return only Risks associated with that specific vendor, such as Risks related to vendor security assessments, data processing agreements, or third-party service dependencies. At least 1.

**Outputs**: Result.

- `data` (object): The complete service response; record and list fields retain their API names.
- `has_more` (true/false): Whether the API reports another page.
- `next_cursor` (text): Pass to the pagination field for the next page, when Has more is true.

**Example output**

```json
{
  "data": {
    "data": [],
    "pagination": {
      "cursor": null,
      "totalCount": null
    }
  },
  "has_more": false,
  "next_cursor": null
}
```

### List vendors

Find Vendors matching the provided filters. Gets one page; to see more, run it again with the next page it gives.

**Inputs**

- Cursor (`cursor`, text): This parameter is used to paginate through results. No value is needed for the first request. If there are additional results, the response will contain a `pagination.cursor` value that can be used in the subsequent request to retrieve the next page of results
- Size (`size`, number): Number of results to return. From 1 to 500.
- Sort (`sort`, text): Which field to sort by. One of: `createdAt`, `updatedAt`.
- Sort dir (`sort_dir`, text): The direction to sort the data. One of: `ASC`, `DESC`.
- Include total count (`include_total_count`, true/false): Include total count of all matching records in response. Only honored on first page (when cursor is null).
- Category (`category`, text): The category of the Vendors. One of: `ENGINEERING`, `PRODUCT`, `MARKETING`, `CS`, `SALES`, `FINANCE`, `HR`, `ADMINISTRATIVE`, `SECURITY`, `LEGAL`, `INFORMATION_TECHNOLOGY`, `NONE`.
- Categories (`categories`, list): Filter to Vendors in any of these categories (business unit). Multi-select is OR. One or more of: `ENGINEERING`, `PRODUCT`, `MARKETING`, `CS`, `SALES`, `FINANCE`, `HR`, `ADMINISTRATIVE`, `SECURITY`, `LEGAL`, `INFORMATION_TECHNOLOGY`, `NONE`.
- Expand (`expand`, list): List of subcollections and sub-objects to expand. One or more of: `customFields`, `documents`, `integrations`, `lastQuestionnaire`, `latestSecurityReviews`, `reviews`, `vendorUser`, `vendorRelationshipContact`, `dataAccessedOrProcessed`, `scheduleConfiguration`, and 3 more.
- Impact level (`impact_level`, text): Overall Vendor impact level. One of: `INSIGNIFICANT`, `MINOR`, `MODERATE`, `MAJOR`, `CRITICAL`, `UNSCORED`.
- Renewal date (`renewal_date`, date): Vendor renewal date (date-only YYYY-MM-DD, matched exactly)
- Renewal schedule type (`renewal_schedule_type`, text): Vendor renewal schedule type. One of: `ONE_MONTH`, `TWO_MONTHS`, `THREE_MONTHS`, `SIX_MONTHS`, `ONE_YEAR`, `CUSTOM`, `NONE`.
- Risk (`risk`, text): Filter data to Vendors of this risk level. One of: `NONE`, `LOW`, `MODERATE`, `HIGH`.
- Status (`status`, text): The status of the Vendors. One of: `PROSPECTIVE`, `ACTIVE`, `ARCHIVED`, `APPROVED`, `REJECTED`, `FLAGGED`, `ON_HOLD`, `OFFBOARDED`, `UNDER_REVIEW`, `NONE`.
- Statuses (`statuses`, list): Filter to Vendors in any of these statuses (multi-select is OR). `NONE` matches Vendors with no status set. `CURRENT` matches the current Vendor book: every Vendor that is not PROSPECTIVE or ARCHIVED, including those with no status. One or more of: `PROSPECTIVE`, `ACTIVE`, `ARCHIVED`, `APPROVED`, `REJECTED`, `FLAGGED`, `ON_HOLD`, `OFFBOARDED`, `UNDER_REVIEW`, `NONE`, `CURRENT`.
- Type (`type`, text): Vendor type. One of: `VENDOR`, `SUPPLIER`, `CONTRACTOR`, `PARTNER`, `OTHER`, `NONE`.
- Types (`types`, list): Filter to Vendors of any of these types (multi-select is OR). One or more of: `VENDOR`, `SUPPLIER`, `CONTRACTOR`, `PARTNER`, `OTHER`, `NONE`.
- Is sub processor (`is_sub_processor`, true/false): Filter to sub-processor vendors (true) or non-sub-processors (false)
- Vendor type IDS (`vendor_type_ids`, list): Filter to Vendors of any of these vendor-type ids (the tenant-defined vendor-type taxonomy from vendor settings; resolve names via GET /vendor-types). Multi-select is OR.
- Next review deadline status (`next_review_deadline_status`, list): Filter by next-review-deadline status: NO_RENEWAL / DUE_SOON / OVERDUE (multi-select is OR). One or more of: `NO_RENEWAL`, `DUE_SOON`, `OVERDUE`.
- Action required (`action_required`, true/false): Filter to "action required" vendors: current (not prospective/archived), with a directory entry and an owner email, whose renewal is due soon or overdue
- Vendor user IDS (`vendor_user_ids`, list): Filter to Vendors whose security owner is one of these user IDs. Mirrors the security-owner filter in the app.

**Outputs**: Result.

- `data` (object): The complete service response; record and list fields retain their API names.
- `has_more` (true/false): Whether the API reports another page.
- `next_cursor` (text): Pass to the pagination field for the next page, when Has more is true.

**Example output**

```json
{
  "data": {
    "data": [],
    "pagination": {
      "cursor": null,
      "totalCount": null
    }
  },
  "has_more": false,
  "next_cursor": null
}
```

### List workspaces

List workspaces for your connected Drata account. Gets one page; to see more, run it again with the next page it gives.

**Inputs**

- Cursor (`cursor`, text): This parameter is used to paginate through results. No value is needed for the first request. If there are additional results, the response will contain a `pagination.cursor` value that can be used in the subsequent request to retrieve the next page of results
- Size (`size`, number): Number of results to return. From 1 to 500.
- Sort (`sort`, text): Which field to sort by. One of: `createdAt`, `updatedAt`.
- Sort dir (`sort_dir`, text): The direction to sort the data. One of: `ASC`, `DESC`.
- Include total count (`include_total_count`, true/false): Include total count of all matching records in response. Only honored on first page (when cursor is null).
- Expand (`expand`, list): List of subcollections and sub-objects to expand. One or more of: `frameworks`, `personnelScope`.

**Outputs**: Result.

- `data` (object): The complete service response; record and list fields retain their API names.
- `has_more` (true/false): Whether the API reports another page.
- `next_cursor` (text): Pass to the pagination field for the next page, when Has more is true.

**Example output**

```json
{
  "data": {
    "data": [],
    "pagination": {
      "cursor": null,
      "totalCount": null
    }
  },
  "has_more": false,
  "next_cursor": null
}
```

### Update asset

Update Asset. Requires the Assets: Update Asset permission.

**Inputs**

- Asset ID (`asset_id`, number, required): Asset id. At least 1.
- Name (`name`, text): The Asset name
- Description (`description`, text): The Asset description
- Notes (`notes`, text): The Asset notes
- Owner (`owner_id`, number): The ID of the user to set as Asset owner. At least 1.
- Asset class types (`asset_class_types`, list): The Asset class types. One or more of: `HARDWARE`, `POLICY`, `DOCUMENT`, `PERSONNEL`, `SOFTWARE`, `CODE`, `CONTAINER`, `COMPUTE`, `NETWORKING`, `DATABASE`, `STORAGE`.
- Asset type (`asset_type`, text): The Asset type. One of: `PHYSICAL`, `VIRTUAL`.
- Custom fields (`custom_fields`, list): Custom Fields for the Asset. 💎 Requires your account have the Custom Fields and Formulas feature. Contact your Account Manager for help upgrading.

**Outputs**: Result.

- `data` (object): The complete service response; record and list fields retain their API names.
- `has_more` (true/false): Whether the API reports another page.
- `next_cursor` (text): Pass to the pagination field for the next page, when Has more is true.

**Example output**

```json
{
  "data": {
    "assetClassTypes": [],
    "assetProvider": "example",
    "assetReferenceType": null,
    "assetType": "example",
    "associatedId": null,
    "createdAt": "example",
    "customFields": [],
    "description": "example",
    "device": null,
    "externalId": null,
    "externalOwnerId": null,
    "id": 0,
    "name": "example",
    "notes": null,
    "owner": {
      "avatarUrl": null,
      "backgroundChecks": null,
      "createdAt": "example",
      "documents": [],
      "drataTermsAgreedAt": null,
      "email": "example",
      "firstName": null,
      "id": 0,
      "identities": [],
      "jobTitle": null,
      "lastName": null,
      "roles": [],
      "updatedAt": "example"
    },
    "removedAt": null,
    "updatedAt": "example"
  },
  "has_more": false,
  "next_cursor": null
}
```
