Search Client Risks

Retrieves a paginated list of risks associated with a specific client.

Supports filtering with PII, sorting, and cursor-based pagination.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

Unique identifier of the client

Body Params

Request payload containing filters, pagination and sorting options.

Minimum required payload :
{}

Since this is a POST search endpoint, an empty JSON object is accepted.

Filtering

Filters must be passed inside the filter object.

Supported fields:

  • status
  • treatment
  • owner.email
  • program_name — program names (eq:ISO-27001:2022 or ISO-27001:2022); unknown name → 400

Each risk in the response includes objectives[] with program_name (direct and control-mediated mappings; indirect rows set indirect_mapping: true) and top-level programs[{id,name}].

Examples

"filter": {
  "status": "eq:Not Assessed",
  "treatment": "eq:Avoid",
  "owner.email": "eq:[email protected]",
  "program_name": "eq:ISO-27001:2022"
}

Supported status values

Assessed, Assessment in progress, Closed, Needs Remediation, Not Assessed, Remediated

Supported treatment values

Avoid, Reduce, Transfer, Share, Accept

Supported operators

  • eq — exact match
  • in — comma-separated list

Example:

"status": "in:Not Assessed,Assessment in progress"

Pagination

  • page_size default = 50
  • page_size max = 200

Cursor Pagination

  • cursor must be Base64 encoded.

Sorting

Allowed fields:

id, name, current_risk, owner.name

Sorting rules:

  • Ascending → name or +name
  • Descending → -name

Query request for risks with filters, fields, pagination, cursor, and sort

filter
object
string

Comma-separated response field list for sparse fieldsets.

int32
1 to 200
string
^[A-Za-z0-9+/=]*$
string
^[+-](id|name|current_risk|owner\.name)(,[+-](id|name|current_risk|owner\.name))*$

Sort field for the risk query.

Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json