Find personnel by search terms and filters

List personnel given the search terms and filters

Securitybearer
Request
query Parameters
page
number >= 1
Default: 1

Which page of data are you requesting

limit
number [ 1 .. 50 ]
Default: 20

How many items are you requesting

q
string

Filter data by searching for first name, last name, full name, or email

Example: q=John Doe
employmentStatus
string

Filter data to personnel of this employment status

Enum: "CURRENT_EMPLOYEE" "FORMER_EMPLOYEE" "CURRENT_CONTRACTOR" "FORMER_CONTRACTOR" "OUT_OF_SCOPE" "UNKNOWN" "SPECIAL_FORMER_EMPLOYEE" "SPECIAL_FORMER_CONTRACTOR" "FUTURE_HIRE" "SERVICE_ACCOUNT"
Example: employmentStatus=CURRENT_EMPLOYEE
employmentStatuses[]
Array of strings

Filter data to personnel of these employment statuses

Items Enum: "CURRENT_EMPLOYEE" "FORMER_EMPLOYEE" "CURRENT_CONTRACTOR" "FORMER_CONTRACTOR" "OUT_OF_SCOPE" "UNKNOWN" "SPECIAL_FORMER_EMPLOYEE" "SPECIAL_FORMER_CONTRACTOR" "FUTURE_HIRE" "SERVICE_ACCOUNT" "ALL_CURRENT_PERSONNEL" "ALL_FORMER_PERSONNEL" "ALL_PERSONNEL"
Example: employmentStatuses[]=CURRENT_EMPLOYEE
fullCompliance
boolean

Filter personnel by a compliance

acceptedPoliciesCompliance
boolean

Filter personnel by accepted policies compliance

identityMfaCompliance
boolean

Filter personnel by identity MFA compliance

bgCheckCompliance
boolean

Filter personnel by background check compliance

agentInstalledCompliance
boolean

Filter personnel by monitor agent installation compliance

passwordManagerCompliance
boolean

Filter personnel by password manager compliance

autoUpdatesCompliance
boolean

Filter personnel by auto updates compliance

locationServicesCompliance
boolean

Filter personnel by location services compliance

hdEncryptionCompliance
boolean

Filter personnel by HD encryption compliance

antivirusCompliance
boolean

Filter personnel by antivirus compliance

lockScreenCompliance
boolean

Filter personnel by lock screen compliance

securityTrainingCompliance
boolean

Filter personnel by security training compliance

hipaaTrainingCompliance
boolean

Filter personnel by HIPAA Training compliance

nistaiTrainingCompliance
boolean

Filter personnel by AI Awareness TRaining compliance

deviceCompliance
boolean

Filter personnel by their device compliance

multiSecurityTrainingCompliance
boolean

Filter personnel by their training compliance

multiTrainingComplianceType
string

Type of training campaigns (default: SECURITY_TRAINING)

Enum: "SECURITY_TRAINING" "HIPAA_TRAINING" "NIST_AI_TRAINING"
Example: multiTrainingComplianceType=SECURITY_TRAINING
offboardingEvidence
boolean

Filter personnel by their offboarding evidence compliance

groupIds
Array of numbers

List of groups to find personnel by

sort
string

Which type of sort (default: NAME)

Enum: "NAME" "EMPLOYMENT_STATUS" "ACCEPTED_POLICIES" "FULL_COMPLIANCE" "IDENTITY_MFA" "BG_CHECK" "AGENT_INSTALLED" "OS_VERSION" "SERIAL_NUM" "PASSWORD_MANAGER" "AUTO_UPDATES" "HDD_ENCRYPTION" "ANTIVIRUS" "APPS_COUNT" "START_DATE" "SEPARATION_DATE" "LOCK_SCREEN" "SECURITY_TRAINING" "HIPAA_TRAINING" "NIST_AI_TRAINING" "OFFBOARDING"
Example: sort=NAME
sortDir
string

Which direction to sort the data (default: ASC)

Enum: "ASC" "DESC"
Example: sortDir=ASC
mdmSourceType
string

Filter data to personnel of this Mdm source type

Enum: "AGENT" "JAMF" "INTUNE" "KANDJI" "JUMPCLOUD" "HEXNODE_UEM" "UNKNOWN" "RIPPLING" "WORKSPACE_ONE" "KOLIDE"
Example: mdmSourceType=AGENT
inverseMdmSourceTypes[]
Array of strings

Inverse filter data to personnel of these Mdm source types

Items Enum: "AGENT" "JAMF" "INTUNE" "KANDJI" "JUMPCLOUD" "HEXNODE_UEM" "UNKNOWN" "RIPPLING" "WORKSPACE_ONE" "KOLIDE"
Example: inverseMdmSourceTypes[]=AGENT
Responses
200
400

Malformed data and/or validation errors

401

Invalid Authorization

403

You are not allowed to perform this action

404

Record Not Found

500

Internal server error

default

Response Code: 412

You must accept the Drata terms and conditions to use the API

get/personnel
Request samples 
Response samples 
application/json
{
  • "data": [
    • {
      • "id": 1,
      • "employmentStatus": "CURRENT_EMPLOYEE",
      • "notHumanReason": "This is not a real personnel, but a placeholder for anyone in charge of X",
      • "osVersion": "Windows 3.1",
      • "serialNumber": "1A2B3C4D",
      • "user": {
        • "id": 1,
        • "email": "[email protected]",
        • "firstName": "Sally",
        • "lastName": "Smith",
        • "jobTitle": "CEO",
        • "avatarUrl": "https://cdn-prod.imgpilot.com/avatar.png",
        • "drataTermsAgreedAt": "2020-07-06 12:00:00.000000",
        • "createdAt": "2020-07-06 12:00:00.000000",
        • "updatedAt": "2020-07-06 12:00:00.000000",
        • "roles": [
          • "ROLE",
          • "ANOTHER_ROLE"
          ],
        • "backgroundChecks": [
          • {
            • "id": 1,
            • "userId": 1,
            • "status": "OK",
            • "caseId": "abc123",
            • "caseInvitationId": "abc123",
            • "url": "https://app-stage.karmacheck.com/background_check/aaaaaaaa-bbbb-0000-cccc-dddddddddddd",
            • "manualCheckDate": "2020-07-06",
            • "manuallyCheckUrl": "url.com",
            • "type": "CERTN",
            • "source": "DRATA",
            • "reportData": "string",
            • "user": { },
            • "outOfScopeReason": "abc123",
            • "outOfScopeAt": "2020-07-06 12:00:00.000000",
            • "invitationEmail": "[email protected]",
            • "linkedAt": "2020-07-06 12:00:00.000000",
            • "createdAt": "2020-07-06 12:00:00.000000",
            • "updatedAt": "2020-07-06 12:00:00.000000"
            }
          ],
        • "identities": [
          • {
            • "id": 1,
            • "identityId": "1a2b3c",
            • "username": "Username",
            • "connectedAt": "2020-07-06 12:00:00.000000",
            • "disconnectedAt": "2020-07-06 12:00:00.000000",
            • "hasMfa": true,
            • "user": { },
            • "connection": {
              • "id": "1",
              • "clientType": "GOOGLE",
              • "state": "ACTIVE",
              • "connected": false,
              • "connectedAt": "2020-07-06 12:00:00.000000",
              • "failedAt": "2020-07-06 12:00:00.000000",
              • "companyId": "12341234",
              • "assignmentId": "FLk12AsS",
              • "user": { },
              • "accountId": "string",
              • "clientId": "drata.com",
              • "clientAlias": "My-connection-alias-1",
              • "manuallyUpdatedAt": "2020-07-06 12:00:00.000000",
              • "aliasUpdatedAt": "2020-07-06 12:00:00.000000",
              • "deletedAt": "2020-07-06 12:00:00.000000",
              • "requestorId": "328d3016-71f3-4485-af20-06ce8044da18",
              • "product": "",
              • "writeAccessEnabled": false,
              • "sourcePreference": "LABEL",
              • "securityLabel": "Jira Security Label",
              • "jqlQuery": "project = IT AND type = \"Offboarding\"",
              • "authorized": true,
              • "workspaces": [],
              • "providerTypes": [
                • 5
                ],
              • "code": 10010,
              • "groupLabel": "Everyone"
              },
            • "hasIdp": true
            }
          ]
        },
      • "reasonProvider": { },
      • "complianceChecks": "[]",
      • "complianceTests": "[]",
      • "startDate": "2020-07-06",
      • "separationDate": "2020-07-06",
      • "statusUpdatedAt": "2019-08-24T14:15:22Z",
      • "data": {
        • "osVersion": "MacOS 10.15.6",
        • "serialNumber": "C02T6CDJGTFL",
        • "screenLockTime": "60",
        • "agentVersion": "1.0",
        • "macAddress": "65-F9-3D-85-7B-6B,99-A9-3E-14-7A-3E",
        • "lastcheckedAt": "2020-07-06 12:00:00.000000",
        • "createdAt": "2020-07-06 12:00:00.000000",
        • "updatedAt": "2020-07-06 12:00:00.000000"
        },
      • "createdAt": "2020-07-06 12:00:00.000000",
      • "updatedAt": "2020-07-06 12:00:00.000000",
      • "devices": "[]",
      • "agentEnabled": false,
      • "manualUploadEnabled": false,
      • "devicesCount": 0,
      • "devicesFailingComplianceCount": 0
      }
    ],
  • "page": 1,
  • "limit": 10,
  • "total": 100,
  • "dataAll": { }
}