Drata

App · 25 actions

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

Actions

ActionWhat it does
Create assetManually add a new Asset to the Account.
Delete assetRemove a virtual or manually-added Asset.
Get assetGet asset for your connected Drata account.
Get auditGet audit for your connected Drata account.
Get companyGet company for your connected Drata account.
Get controlGet all the information for a specific Control.
Get deviceGet device for your connected Drata account.
Get eventGet details for an Event.
Get evidenceGet a specific evidence item by ID with optional expand.
Get personGet a single Personnel record.
Get vendorGet vendor for your connected Drata account.
List assetsFind Assets by search terms and filters.
List auditsList audits for your connected Drata account.
List controlsFind Controls matching the provided filters.
List devicesList devices for your connected Drata account.
List eventsFind Events matching the provided filters.
List evidenceList evidence items with pagination, filtering, and optional expand.
List frameworksFind Frameworks matching the provided filters.
List monitoring testsFind Monitoring Tests matching the provided filters.
List personnelGet a paginated list of Personnel records.
List risk registersRetrieve all Risk Registers associated with the account.
List risksFind Risks matching the provided filters.
List vendorsFind Vendors matching the provided filters.
List workspacesList workspaces for your connected Drata account.
Update assetUpdate Asset.

Create asset

Manually add a new Asset to the Account.

Inputs

NamenametextRequired
The Asset name
DescriptiondescriptiontextRequired
The Asset description
Notesnotestext
The Asset notes
Asset class typesasset_class_typeslistRequired
The Asset class typesOne or more of: HARDWARE, POLICY, DOCUMENT, PERSONNEL, SOFTWARE, CODE, CONTAINER, COMPUTE, NETWORKING, DATABASE, STORAGE.
Asset typeasset_typetextRequired
The Asset typeOne of: PHYSICAL, VIRTUAL.
Ownerowner_idnumberRequired
The owner IDAt least 1.
Associated IDassociated_idtext
An ID associated with this Asset
Removed atremoved_atdate and time
Date the Asset was removed
External IDexternal_idtext
An externally sourced unique identifier for a virtual Asset
External owner IDexternal_owner_idtext
Used to track the source of virtual Assets, typically an account ID
Custom fieldscustom_fieldslist
Custom Fields for the Asset. 💎 Requires your account have the Custom Fields and Formulas feature. Contact your Account Manager for help upgrading.

Outputs

Result.

dataobject
The complete service response; record and list fields retain their API names.
has_moretrue/false
Whether the API reports another page.
next_cursortext
Pass to the pagination field for the next page, when Has more is true.
Example output
{
  "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 IDasset_idnumberRequired
Asset id.At least 1.

Outputs

Result.

datanull
The complete service response; record and list fields retain their API names.
has_moretrue/false
Whether the API reports another page.
next_cursortext
Pass to the pagination field for the next page, when Has more is true.
Example output
{
  "data": null,
  "has_more": false,
  "next_cursor": null
}

Get asset

Get asset for your connected Drata account.

Inputs

Asset IDasset_idnumberRequired
Asset id.At least 1.
Expandexpandlist
List of subcollections and sub-objects to expandOne or more of: device, assetClassTypes, complianceChecks, customFields, identifiers, owner.

Outputs

Result.

dataobject
The complete service response; record and list fields retain their API names.
has_moretrue/false
Whether the API reports another page.
next_cursortext
Pass to the pagination field for the next page, when Has more is true.
Example output
{
  "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

Expandexpandlist
List of subcollections and sub-objects to expandOne or more of: auditors, internalAuditors, controls.
Workspaceworkspace_idnumberRequired
The Workspace ID associated to the AccountAt least 1.
Audit IDaudit_idtextRequired
Audit id.

Outputs

Result.

dataobject
The complete service response; record and list fields retain their API names.
has_moretrue/false
Whether the API reports another page.
next_cursortext
Pass to the pagination field for the next page, when Has more is true.
Example output
{
  "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.

dataobject
The complete service response; record and list fields retain their API names.
has_moretrue/false
Whether the API reports another page.
next_cursortext
Pass to the pagination field for the next page, when Has more is true.
Example output
{
  "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

Workspaceworkspace_idnumberRequired
The Workspace ID associated to the AccountAt least 1.
Cursorcursortext
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
Sizesizenumber
Number of results to returnFrom 1 to 500.
Sortsorttext
Which field to sort byOne of: createdAt, updatedAt.
Sort dirsort_dirtext
The direction to sort the dataOne of: ASC, DESC.
Expandexpandlist
List of subcollections and sub-objects to expandOne or more of: customFields, evidenceIds, flags, frameworkTags, owners, requirements, testIds, topics.
Control IDcontrol_idnumberRequired
An integer control ID or a control code prefixed with `code:`At least 1.

Outputs

Result.

dataobject
The complete service response; record and list fields retain their API names.
has_moretrue/false
Whether the API reports another page.
next_cursortext
Pass to the pagination field for the next page, when Has more is true.
Example output
{
  "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 IDdevice_idnumberRequired
The device IDAt least 1.
Expandexpandlist
List of subcollections and sub-objects to expandOne or more of: asset, complianceChecks, documents, identifiers, deviceApps.

Outputs

Result.

dataobject
The complete service response; record and list fields retain their API names.
has_moretrue/false
Whether the API reports another page.
next_cursortext
Pass to the pagination field for the next page, when Has more is true.
Example output
{
  "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 IDevent_idtextRequired
Event id.
Cursorcursortext
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
Sizesizenumber
Number of results to returnFrom 1 to 500.
Sortsorttext
Which field to sort byOne of: createdAt, updatedAt.
Sort dirsort_dirtext
The direction to sort the dataOne of: ASC, DESC.
Expandexpandlist
List of subcollections and sub-objects to expandOne or more of: connection, issues, metadata, testId, testName, user.

Outputs

Result.

dataobject
The complete service response; record and list fields retain their API names.
has_moretrue/false
Whether the API reports another page.
next_cursortext
Pass to the pagination field for the next page, when Has more is true.
Example output
{
  "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

Workspaceworkspace_idnumberRequired
The Workspace ID associated to the AccountAt least 1.
Evidence IDevidence_idnumberRequired
Evidence id.At least 1.
Expandexpandlist
List of subcollections and sub-objects to expandOne or more of: owners, artifacts, controls.

Outputs

Result.

dataobject
The complete service response; record and list fields retain their API names.
has_moretrue/false
Whether the API reports another page.
next_cursortext
Pass to the pagination field for the next page, when Has more is true.
Example output
{
  "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

Expandexpandlist
List of subcollections and sub-objects to expandOne or more of: customFields, complianceChecks, reasonProvider, user.
Personnel IDpersonnel_idnumberRequired
An integer Personnel ID or User's email address prefixed with `email:`At least 1.

Outputs

Result.

dataobject
The complete service response; record and list fields retain their API names.
has_moretrue/false
Whether the API reports another page.
next_cursortext
Pass to the pagination field for the next page, when Has more is true.
Example output
{
  "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 IDvendor_idnumberRequired
Vendor id.At least 1.
Expandexpandlist
List of subcollections and sub-objects to expandOne or more of: customFields, documents, integrations, lastQuestionnaire, latestSecurityReviews, reviews, vendorUser, vendorRelationshipContact, dataAccessedOrProcessed, scheduleConfiguration, and 3 more.

Outputs

Result.

dataobject
The complete service response; record and list fields retain their API names.
has_moretrue/false
Whether the API reports another page.
next_cursortext
Pass to the pagination field for the next page, when Has more is true.
Example output
{
  "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

Cursorcursortext
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
Sizesizenumber
Number of results to returnFrom 1 to 500.
Sortsorttext
Which field to sort byOne of: createdAt, updatedAt.
Sort dirsort_dirtext
The direction to sort the dataOne of: ASC, DESC.
Include total countinclude_total_counttrue/false
Include total count of all matching records in response. Only honored on first page (when cursor is null).
Expandexpandlist
List of subcollections and sub-objects to expandOne or more of: device, assetClassTypes, complianceChecks, customFields, identifiers, owner.
Asset class typeasset_class_typetext
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 typeasset_typetext
Filter assets by typeOne of: PHYSICAL, VIRTUAL.
Asset providerasset_providertext
Filter assets by providerOne of: DRATA_DEV, AGENT, DRATA, GOOGLE, MICROSOFT_365, JAMF, INTUNE, OKTA_IDENTITY, KANDJI, JUMPCLOUD, and 18 more.
Target user IDtarget_user_idnumber
Filter data by user ID associated to the AssetsFrom 1 to 1000000000.
Employment statusemployment_statustext
Filter data by personnel of this employment statusOne 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.

dataobject
The complete service response; record and list fields retain their API names.
has_moretrue/false
Whether the API reports another page.
next_cursortext
Pass to the pagination field for the next page, when Has more is true.
Example output
{
  "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

Cursorcursortext
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
Sizesizenumber
Number of results to returnFrom 1 to 500.
Sortsorttext
Which field to sort byOne of: createdAt, updatedAt.
Sort dirsort_dirtext
The direction to sort the dataOne of: ASC, DESC.
Expandexpandlist
List of subcollections and sub-objects to expandOne or more of: auditors, internalAuditors.
Workspaceworkspace_idnumberRequired
The Workspace ID associated to the AccountAt least 1.

Outputs

Result.

dataobject
The complete service response; record and list fields retain their API names.
has_moretrue/false
Whether the API reports another page.
next_cursortext
Pass to the pagination field for the next page, when Has more is true.
Example output
{
  "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

Workspaceworkspace_idnumberRequired
The Workspace ID associated to the AccountAt least 1.
Cursorcursortext
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
Sizesizenumber
Number of results to returnFrom 1 to 500.
Sortsorttext
Which field to sort byOne of: createdAt, updatedAt.
Sort dirsort_dirtext
The direction to sort the dataOne of: ASC, DESC.
Include total countinclude_total_counttrue/false
Include total count of all matching records in response. Only honored on first page (when cursor is null).
Expandexpandlist
List of subcollections and sub-objects to expandOne or more of: customFields, evidenceIds, flags, frameworkTags, owners, requirements, testIds, topics.
Is monitoredis_monitoredtrue/false
Filter Controls that have or do not have a Monitor
Is readyis_readytrue/false
Filter Controls that are or are not ready
Has evidencehas_evidencetrue/false
Filter to Controls with or without Evidence
Has policyhas_policytrue/false
Filter to Controls with or without Policy
Has passing testhas_passing_testtrue/false
Filter to Controls with at least one passing Test
Ticket statusticket_statustext
Only include Controls with an associated Task Management TicketOne of: IN_PROGRESS, ARCHIVED.
Policy IDpolicy_idnumber
Filter Controls associated with a specific Policy IDAt least 1.
Is enabledis_enabledtrue/false
Filter Controls that are or are not enabled
Is archivedis_archivedtrue/false
Filter Controls that are or are not archived
Required approvalsrequired_approvalstext
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.

dataobject
The complete service response; record and list fields retain their API names.
has_moretrue/false
Whether the API reports another page.
next_cursortext
Pass to the pagination field for the next page, when Has more is true.
Example output
{
  "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

Cursorcursortext
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
Sizesizenumber
Number of results to returnFrom 1 to 500.
Sortsorttext
Which field to sort byOne of: createdAt, updatedAt.
Sort dirsort_dirtext
The direction to sort the dataOne of: ASC, DESC.
Include total countinclude_total_counttrue/false
Include total count of all matching records in response. Only honored on first page (when cursor is null).
External IDexternal_idtext
An externally sourced unique identifier for a device
Expandexpandlist
List of subcollections and sub-objects to expandOne or more of: asset, complianceChecks, documents, identifiers.
Mac addressmac_addresstext
The device MAC address
Serial numberserial_numbertext
The device serial number
Source typesource_typetext
Device source typeOne of: AGENT, JAMF, INTUNE, KANDJI, JUMPCLOUD, HEXNODE_UEM, UNKNOWN, RIPPLING, WORKSPACE_ONE, KOLIDE, and 4 more.
Personnel IDpersonnel_idnumber
Personnel IDAt least 1.

Outputs

Result.

dataobject
The complete service response; record and list fields retain their API names.
has_moretrue/false
Whether the API reports another page.
next_cursortext
Pass to the pagination field for the next page, when Has more is true.
Example output
{
  "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

Cursorcursortext
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
Sizesizenumber
Number of results to returnFrom 1 to 500.
Sortsorttext
Events can only be sorted by create dateOne of: createdAt.
Sort dirsort_dirtext
The direction to sort the dataOne of: ASC, DESC.
Include total countinclude_total_counttrue/false
Include total count of all matching records in response. Only honored on first page (when cursor is null).
Expandexpandlist
List of subcollections and sub-objects to expandOne or more of: connection, issues, metadata, testId, testName, user.
Typetypetext
Filter data to events of this typeOne 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.
Sourcesourcetext
Filter data to events of this sourceOne of: APP, AUTOPILOT, PUBLIC_API, VENDOR_QUESTIONNAIRE, SCHEDULED, WORKFLOW, DRATA_POLICY, AUDIT_AGENT.
Categorycategorytext
Filter data to events of this categoryOne of: AUTOPILOT, AGENT, POLICY, PERSONNEL, REPORT, VENDOR, ASSET, COMPANY, ASSESSMENT, AUDIT, and 33 more.
Drata connection IDdrata_connection_idnumber
The connection to filter events by. A null/blank value will return events without a connection.At least 1.
Target user IDtarget_user_idnumber
The user to filter events by. A null/blank value will return events without a user.At least 1.
Workspaceworkspace_idnumber
The workspace to filter events toAt least 1.
Created at start datecreated_at_start_datedate and time
Filters the events to those with a creation date greater than or equal to this date and time.
Created at end datecreated_at_end_datedate and time
Filters the events to those with a creation date less than or equal to this date and time

Outputs

Result.

dataobject
The complete service response; record and list fields retain their API names.
has_moretrue/false
Whether the API reports another page.
next_cursortext
Pass to the pagination field for the next page, when Has more is true.
Example output
{
  "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

Workspaceworkspace_idnumberRequired
The Workspace ID associated to the AccountAt least 1.
Cursorcursortext
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
Sizesizenumber
Number of results to returnFrom 1 to 500.
Sortsorttext
Which field to sort byOne of: createdAt, updatedAt.
Sort dirsort_dirtext
The direction to sort the dataOne of: ASC, DESC.
Expandexpandlist
List of subcollections and sub-objects to expandOne or more of: owners, artifacts, controls.
Namenametext
Filter evidence items by name (prefix match)
Owner IDSowner_idslist
IDs of the users that own the evidence current version.
Framework IDSframework_idslist
Array of Ids of frameworks to be used as filters
Evidence statusesevidence_statuseslist
Filter evidence items by statusesOne or more of: NEEDS_ARTIFACT, EXPIRED, EXPIRING_SOON, TEST_ERROR, TEST_FAILED, READY, TEST_PASSED, TEST_UNUSED, TEST_DISABLED, TEST_DELETED.
Artifact typesartifact_typeslist
Filter evidence items by artifact typesOne or more of: URL, S3_FILE, TICKET_PROVIDER, NONE, GOOGLE_DRIVE, ONE_DRIVE, BOX, DROPBOX, SHARE_POINT, TEST_RESULT.

Outputs

Result.

dataobject
The complete service response; record and list fields retain their API names.
has_moretrue/false
Whether the API reports another page.
next_cursortext
Pass to the pagination field for the next page, when Has more is true.
Example output
{
  "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

Workspaceworkspace_idnumberRequired
The Workspace ID associated to the AccountAt least 1.
Cursorcursortext
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
Sizesizenumber
Number of results to returnFrom 1 to 500.
Sortsorttext
Which field to sort byOne of: createdAt, updatedAt.
Sort dirsort_dirtext
The direction to sort the dataOne of: ASC, DESC.
Include total countinclude_total_counttrue/false
Include total count of all matching records in response. Only honored on first page (when cursor is null).
Namenametext
Filter Frameworks by name (partial match)
Exclude IDSexclude_idslist
Array of Framework IDs to exclude from results
Is readyis_readytrue/false
Filter Frameworks by ready state
Is enabledis_enabledtrue/false
Filter Frameworks by enabled state

Outputs

Result.

dataobject
The complete service response; record and list fields retain their API names.
has_moretrue/false
Whether the API reports another page.
next_cursortext
Pass to the pagination field for the next page, when Has more is true.
Example output
{
  "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

Workspaceworkspace_idnumberRequired
The Workspace ID associated to the AccountAt least 1.
Cursorcursortext
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
Sizesizenumber
Number of results to returnFrom 1 to 500.
Sortsorttext
Which field to sort byOne of: createdAt, updatedAt.
Sort dirsort_dirtext
The direction to sort the dataOne of: ASC, DESC.
Include total countinclude_total_counttrue/false
Include total count of all matching records in response. Only honored on first page (when cursor is null).
Expandexpandlist
List of subcollections and sub-objects to expandOne or more of: controls, monitorInstances, disablingUser.
Check result statuscheck_result_statustext
Filter Monitors by result statusOne of: READY, PASSED, FAILED, ERROR, PREAUDIT.
Check statuscheck_statustext
Filter Monitors by system statusOne of: UNUSED, NEW, ENABLED, DISABLED, TESTING.
Typetypetext
Filter Monitors by check type (associated monitor instances)One of: POLICY, IN_DRATA, AGENT, INFRASTRUCTURE, VERSION_CONTROL, IDENTITY, TICKETING, HRIS, OBSERVABILITY, CUSTOM.
Test sourcetest_sourcetext
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.

dataobject
The complete service response; record and list fields retain their API names.
has_moretrue/false
Whether the API reports another page.
next_cursortext
Pass to the pagination field for the next page, when Has more is true.
Example output
{
  "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

Cursorcursortext
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
Sizesizenumber
Number of results to returnFrom 1 to 500.
Sortsorttext
Which field to sort byOne of: createdAt, updatedAt.
Sort dirsort_dirtext
The direction to sort the dataOne of: ASC, DESC.
Include total countinclude_total_counttrue/false
Include total count of all matching records in response. Only honored on first page (when cursor is null).
Expandexpandlist
List of subcollections and sub-objects to expandOne or more of: customFields, complianceChecks, reasonProvider, user.
Employment statusemployment_statuslist
Personnel by employment statusesOne 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 statuscompliance_statuslist
Filter Personnel by overall compliance statusOne or more of: MISCONFIGURED, PASS, FAIL, EXCLUDED, NOT_ASSESSED.

Outputs

Result.

dataobject
The complete service response; record and list fields retain their API names.
has_moretrue/false
Whether the API reports another page.
next_cursortext
Pass to the pagination field for the next page, when Has more is true.
Example output
{
  "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

Cursorcursortext
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
Sizesizenumber
Number of results to returnFrom 1 to 500.
Sortsorttext
Which field to sort byOne of: createdAt, updatedAt.
Sort dirsort_dirtext
The direction to sort the dataOne of: ASC, DESC.
Include total countinclude_total_counttrue/false
Include total count of all matching records in response. Only honored on first page (when cursor is null).
Namenametext
Search query for Register name
Owner IDSowner_idslist
User IDs of the Register Owners to filter by
Workspace IDSworkspace_idslist
Workspace IDs to filter Risk Registers by
Expandexpandlist
List of subcollections and sub-objects to expandOne or more of: workspaces.

Outputs

Result.

dataobject
The complete service response; record and list fields retain their API names.
has_moretrue/false
Whether the API reports another page.
next_cursortext
Pass to the pagination field for the next page, when Has more is true.
Example output
{
  "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 registerrisk_register_idnumberRequired
The Risk Register IDAt least 1.
Cursorcursortext
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
Sizesizenumber
Number of results to returnFrom 1 to 500.
Sortsorttext
Which field to sort byOne of: createdAt, updatedAt.
Sort dirsort_dirtext
The direction to sort the dataOne of: ASC, DESC.
Include total countinclude_total_counttrue/false
Include total count of all matching records in response. Only honored on first page (when cursor is null).
Expandexpandlist
List of subcollections and sub-objects to expandOne or more of: owners, reviewers, controls, categories, documents, notes, tickets, tasks, customFields.
Titletitletext
Filter Risks by title. Performs a case-insensitive partial match on the Risk title field.
Statusstatustext
Filter Risks by statusOne of: ACTIVE, ARCHIVED, CLOSED.
Treatment plantreatment_plantext
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 scoremin_scorenumber
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 scoremax_scorenumber
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 IDvendor_idnumber
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.

dataobject
The complete service response; record and list fields retain their API names.
has_moretrue/false
Whether the API reports another page.
next_cursortext
Pass to the pagination field for the next page, when Has more is true.
Example output
{
  "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

Cursorcursortext
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
Sizesizenumber
Number of results to returnFrom 1 to 500.
Sortsorttext
Which field to sort byOne of: createdAt, updatedAt.
Sort dirsort_dirtext
The direction to sort the dataOne of: ASC, DESC.
Include total countinclude_total_counttrue/false
Include total count of all matching records in response. Only honored on first page (when cursor is null).
Categorycategorytext
The category of the VendorsOne of: ENGINEERING, PRODUCT, MARKETING, CS, SALES, FINANCE, HR, ADMINISTRATIVE, SECURITY, LEGAL, INFORMATION_TECHNOLOGY, NONE.
Categoriescategorieslist
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.
Expandexpandlist
List of subcollections and sub-objects to expandOne or more of: customFields, documents, integrations, lastQuestionnaire, latestSecurityReviews, reviews, vendorUser, vendorRelationshipContact, dataAccessedOrProcessed, scheduleConfiguration, and 3 more.
Impact levelimpact_leveltext
Overall Vendor impact levelOne of: INSIGNIFICANT, MINOR, MODERATE, MAJOR, CRITICAL, UNSCORED.
Renewal daterenewal_datedate
Vendor renewal date (date-only YYYY-MM-DD, matched exactly)
Renewal schedule typerenewal_schedule_typetext
Vendor renewal schedule typeOne of: ONE_MONTH, TWO_MONTHS, THREE_MONTHS, SIX_MONTHS, ONE_YEAR, CUSTOM, NONE.
Riskrisktext
Filter data to Vendors of this risk levelOne of: NONE, LOW, MODERATE, HIGH.
Statusstatustext
The status of the VendorsOne of: PROSPECTIVE, ACTIVE, ARCHIVED, APPROVED, REJECTED, FLAGGED, ON_HOLD, OFFBOARDED, UNDER_REVIEW, NONE.
Statusesstatuseslist
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.
Typetypetext
Vendor typeOne of: VENDOR, SUPPLIER, CONTRACTOR, PARTNER, OTHER, NONE.
Typestypeslist
Filter to Vendors of any of these types (multi-select is OR)One or more of: VENDOR, SUPPLIER, CONTRACTOR, PARTNER, OTHER, NONE.
Is sub processoris_sub_processortrue/false
Filter to sub-processor vendors (true) or non-sub-processors (false)
Vendor type IDSvendor_type_idslist
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 statusnext_review_deadline_statuslist
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 requiredaction_requiredtrue/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 IDSvendor_user_idslist
Filter to Vendors whose security owner is one of these user IDs. Mirrors the security-owner filter in the app.

Outputs

Result.

dataobject
The complete service response; record and list fields retain their API names.
has_moretrue/false
Whether the API reports another page.
next_cursortext
Pass to the pagination field for the next page, when Has more is true.
Example output
{
  "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

Cursorcursortext
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
Sizesizenumber
Number of results to returnFrom 1 to 500.
Sortsorttext
Which field to sort byOne of: createdAt, updatedAt.
Sort dirsort_dirtext
The direction to sort the dataOne of: ASC, DESC.
Include total countinclude_total_counttrue/false
Include total count of all matching records in response. Only honored on first page (when cursor is null).
Expandexpandlist
List of subcollections and sub-objects to expandOne or more of: frameworks, personnelScope.

Outputs

Result.

dataobject
The complete service response; record and list fields retain their API names.
has_moretrue/false
Whether the API reports another page.
next_cursortext
Pass to the pagination field for the next page, when Has more is true.
Example output
{
  "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 IDasset_idnumberRequired
Asset id.At least 1.
Namenametext
The Asset name
Descriptiondescriptiontext
The Asset description
Notesnotestext
The Asset notes
Ownerowner_idnumber
The ID of the user to set as Asset ownerAt least 1.
Asset class typesasset_class_typeslist
The Asset class typesOne or more of: HARDWARE, POLICY, DOCUMENT, PERSONNEL, SOFTWARE, CODE, CONTAINER, COMPUTE, NETWORKING, DATABASE, STORAGE.
Asset typeasset_typetext
The Asset typeOne of: PHYSICAL, VIRTUAL.
Custom fieldscustom_fieldslist
Custom Fields for the Asset. 💎 Requires your account have the Custom Fields and Formulas feature. Contact your Account Manager for help upgrading.

Outputs

Result.

dataobject
The complete service response; record and list fields retain their API names.
has_moretrue/false
Whether the API reports another page.
next_cursortext
Pass to the pagination field for the next page, when Has more is true.
Example output
{
  "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
}

On this page