Customer Request

Find customer requests by search terms and filters

Get customer request list

🔒 Requires Customer Request: Get Customer Request permission.

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

Which page of data are you requesting

limit
number [ 1 .. 200 ]
Default: 20

How many items are you requesting

q
string

Filter data by searching for framework names

userIds
Array of numbers

User Ids of customer request owners

Example: userIds=1
isOwned
boolean

Filter owned requests

Example: isOwned=true
auditId
required
string

Audit ID

Example: auditId=123e4567-e89b-12d3-a456-426614174000
status
Array of strings or null

Customer request statuses.

Enum: "OUTSTANDING" "IN_REVIEW" "ACCEPTED"
Example: status=OUTSTANDING
onlyWithNewMessages
boolean

Filter data only if request has new messages

Responses
200
400

Malformed data and/or validation errors

401

Invalid Authorization

403

You are not allowed to perform this action

404

Not Found

412

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

500

Internal server error

get/customer-request
Request samples 
Response samples 
application/json
{
  • "totalUnreadMessages": 12,
  • "requests": {
    • "data": [
      • { }
      ],
    • "page": 1,
    • "limit": 10,
    • "total": 100
    }
}
Update the properties of customer request entity by given id
Update customer request details


🔒 Requires Customer Request: Update Customer Request permission.


Securitybearer 
Request 
path Parameters
customerRequestId
required
number
 
Request Body schema: application/json
required
title
required
string
Customer request details title


 
description
string
Customer request details description


 
ownerIds
required
Array of numbers
Array of owner ids


 
Responses 
200
400
Malformed data and/or validation errors


401
Invalid Authorization


403
You are not allowed to perform this action


404
Not Found


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


500
Internal server error


put/customer-request/{customerRequestId}/details
Request samples 
application/json
{
  • "title": "000001",
  • "description": "This is the description",
  • "ownerIds": [
    • 1,
    • 2,
    • 3
    ]
}
Response samples 
application/json
{}