Risks

List organization risks

Changed on

List organization risks with owners, departments, severity, mitigation status, and evidence for risk management reporting.

get/v1/risks

Request

  • Base URL
    https://api.betayum.com
  • URL
    https://api.betayum.com/v1/risks
  • Auth
    API key in header X-API-Key

Query parameters

titlestring
Example:data breach

Search by title (case-insensitive contains)

pagenumber
Example:1

Page number (1-indexed)

perPagenumber
Example:50

Number of items per page

sort'createdAt' | 'updatedAt' | 'title' | 'status'

Sort by field

sortDirection'asc' | 'desc'

Sort direction

status'open' | 'pending' | 'closed' | 'archived'

Filter by status

category'customer' | 'fraud' | 'governance' | 'operations' | 'other' | 'people' | 'regulatory' | 'reporting' | 'resilience' | 'technology' | 'vendor_management'

Filter by category

department'none' | 'admin' | 'gov' | 'hr' | 'it' | 'itsm' | 'qms'

Filter by department

assigneeIdstring
Example:mem_abc123def456

Filter by assignee member ID

Response

Risks retrieved successfully

countnumber

Total number of risks

authType'api-key' | 'session'

How the request was authenticated

Example response

{
  "data": [
    {
      "id": "rsk_abc123def456",
      "title": "Data breach vulnerability in user authentication system",
      "description": "Weak password requirements could lead to unauthorized access to user accounts",
      "category": "technology",
      "status": "open",
      "likelihood": "possible",
      "impact": "major",
      "treatmentStrategy": "mitigate",
      "assigneeId": "mem_abc123def456"
    }
  ],
  "count": 15,
  "authenticatedUser": {
    "id": "usr_def456ghi789",
    "email": "user@example.com"
  }
}

Changes

  • 946edaa856a9Revision changes
    • warning

      deleted the header request parameter X-Organization-Id

    • info

      added the new optional query request parameter assigneeId

    • info

      added the new optional query request parameter category

    • info

      added the new optional query request parameter department

    • info

      added the new optional query request parameter page

    • info

      added the new optional query request parameter perPage

    • info

      added the new optional query request parameter sort

    • info

      added the new optional query request parameter sortDirection

    • info

      added the new optional query request parameter status

    • info

      added the new optional query request parameter title