List risks#
Description#
Return a paginated collection of risks as full representations.
GET /risks
Required OAuth Scopes
grc:read
Parameters#
Parameter |
In |
Type |
Required |
Description |
|---|---|---|---|---|
X-Version |
header |
string |
true |
Version of the API (2026-09-01.grc.preview) |
$maxpagesize |
query |
integer(int32) |
false |
Maximum number of items to return in a single page. The service applies a default and a maximum; requests above the maximum are clamped. |
$next |
query |
string |
false |
Opaque cursor identifying the next page of results, taken from the previous page. Omit on the first request. |
$filter |
query |
string |
false |
Filter expression restricting the collection, of the form |
$orderBy |
query |
string |
false |
Sort criteria of the form `field [asc |
Wk-Workspace |
header |
string |
true |
The id of the Workiva workspace to operate in. Authorization is enforced against the authenticated user’s access within this workspace. |
Filter Options#
Available logical operators: and, or, not
Name |
Predicates Supported |
|---|---|
description |
|
id |
|
name |
|
riskId |
|
Sorting Options#
Name |
Orders Supported |
|---|---|
name |
|
Code Samples#
curl -X GET https://api.app.wdesk.com/risks \
-H 'Accept: application/json' \
-H 'Wk-Workspace: 1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d' \
-H 'Authorization: Bearer {access-token}' \
-H 'X-Version: 2026-09-01.grc.preview'
http GET https://api.app.wdesk.com/risks \
X-Version:2026-09-01.grc.preview \
Accept:application/json \
Wk-Workspace:1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d \
Authorization:"Bearer {access-token}"
wget --method=GET "https://api.app.wdesk.com/risks" \
--output-document - \
--header 'Accept: application/json' \
--header 'Wk-Workspace: 1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d' \
--header 'Authorization: Bearer {access-token}' \
--header 'X-Version: 2026-09-01.grc.preview'
import requests
headers = {
'X-Version': '2026-09-01.grc.preview',
'Accept': 'application/json',
'Wk-Workspace': '1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://api.app.wdesk.com/risks', headers = headers)
print(r.json())
Returns#
200 - A paginated collection of risks.#
A collection of risks.
400 - The request was invalid.#
Error response indicating the service could not process the request.
401 - Authentication is missing or invalid.#
Error response indicating the service could not process the request.
403 - The caller is not permitted to access this resource.#
Error response indicating the service could not process the request.
429 - The rate limit has been exceeded.#
Error response indicating the service could not process the request.
500 - An unexpected error occurred.#
Error response indicating the service could not process the request.
Example Responses#
{
"@nextLink": "https://api.app.wdesk.com/risks?$next=b3BhcXVlLW5leHQtcGFnZS10b2tlbg==",
"data": [
{
"customFields": [
{
"enumValue": "High",
"id": "8f3c1a2b-4d5e-4f6a-8b7c-9d0e1f2a3b4c",
"name": "Risk Rating",
"type": "singleSelectEnum"
}
],
"description": "Risk that account balances are materially misstated.",
"id": "9a8b7c6d-5e4f-4a3b-2c1d-0e9f8a7b6c5d",
"mitigatingControls": [
{
"controlId": "BEN.001",
"id": "d9c09501-214c-432e-85c9-8cd1009b9660",
"name": "General Ledger Reconciliation"
}
],
"name": "Misstated account balances",
"owner": {
"id": "u_4cc9f9128a684f45a7a37b08b70b54c1"
},
"process": {
"id": "2b1e5a7c-3d4f-4a1b-9c2d-6e7f8a9b0c1d",
"name": "Financial Reporting"
},
"riskId": "R.001",
"subProcess": {
"id": "3c2f6b8d-4e5a-4b2c-8d3e-7f8a9b0c1d2e",
"name": "Account Reconciliation"
}
}
]
}
{
"code": "invalidFilter",
"message": "The $filter value could not be parsed.",
"target": "$filter"
}
{
"code": "unauthenticated",
"message": "Authentication credentials were missing or invalid."
}
{
"code": "permissionDenied",
"message": "You do not have permission to access this resource."
}
{
"code": "rateLimitExceeded",
"message": "Rate limit exceeded. Retry after the period indicated in the response headers."
}
{
"code": "internalError",
"message": "An unexpected error occurred. Please try again later."
}