Get all risks
Return all risks for the provided filters. Only filters that the logged-in user has access will be returned.
Query Params
- Name
updatedAfterDate
- Type
- string
- Description
filter by risks updated after specified date (deprecated, use updatedAfter)
- Name
updatedAfter
- Type
- string
- Description
filter by risks updated after specified date
- Name
sortOrder
- Type
- string
- Description
sort order (deprecated, use orderMode)
- Allowed values
asc
desc
- Name
sort
- Type
- string
- Description
sort by (deprecated, use orderBy)
- Allowed values
datecreated
source
probability
impact
result
project
- Name
searchTerm
- Type
- string
- Description
search term
- Name
reportFormat
- Type
- string
- Description
define the format of the report
- Default
pdf
- Name
orderMode
- Type
- string
- Description
sort order
- Allowed values
asc
desc
- Name
orderBy
- Type
- string
- Description
sort by
- Allowed values
datecreated
source
probability
impact
result
project
- Name
probabilityTo
- Type
- integer
- Description
filter by probability
- Name
probabilityFrom
- Type
- integer
- Description
filter by probability
- Name
pageSize
- Type
- integer
- Description
number of items in a page
- Default
50
- Name
page
- Type
- integer
- Description
page number
- Default
1
- Name
impactTo
- Type
- integer
- Description
filter by impact
- Name
impactFrom
- Type
- integer
- Description
filter by impact
- Name
skipCounts
- Type
- boolean
- Description
SkipCounts allows you to skip doing counts on a list API endpoint for performance reasons.
- Name
showDeleted
- Type
- boolean
- Description
include deleted items
- Default
false
- Name
onlyStarredProjects
- Type
- boolean
- Description
filter by starred projects only
- Default
false
- Name
matchAllProjectTags
- Type
- boolean
- Description
enforce all tag ids must be matched
- Name
isReportDownload
- Type
- boolean
- Description
generate a report document
- Name
includeArchivedProjects
- Type
- boolean
- Description
include archived projects
- Name
impactSchedule
- Type
- boolean
- Description
filter by risks that impact schedule
- Name
impactPerformance
- Type
- boolean
- Description
filter by risks that impact performance
- Name
impactCost
- Type
- boolean
- Description
filter by risks that impact cost
- Name
statuses
- Type
- array[string]
- Description
filter by risk statuses
- Format
- Comma separated values
- Allowed values
new
pending
closed
- Name
projectTagIds
- Type
- array[integer]
- Description
filter by project tag ids
- Format
- Comma separated values
- Name
projectStatuses
- Type
- array[string]
- Description
list of project statuses
- Format
- Comma separated values
- Name
projectOwnerIds
- Type
- array[integer]
- Description
filter by project owner ids
- Format
- Comma separated values
- Name
projectIds
- Type
- array[integer]
- Description
filter by project ids
- Format
- Comma separated values
- Name
projectHealths
- Type
- array[integer]
- Description
list of project health
- Format
- Comma separated values
- Name
projectCompanyIds
- Type
- array[integer]
- Description
filter by company ids
- Format
- Comma separated values
- Name
projectCategoryIds
- Type
- array[integer]
- Description
filter by project category ids
- Format
- Comma separated values
- Name
include
- Type
- array[string]
- Description
include
- Format
- Comma separated values
- Allowed values
projects
users
projects.companies
- Name
ids
- Type
- array[integer]
- Description
filter by specific ids
- Format
- Comma separated values
- Name
fields[users]
- Type
- array[string]
- Description
- Format
- Comma separated values
- Allowed values
id
firstName
lastName
title
email
companyId
company
isAdmin
isClientUser
isServiceAccount
type
deleted
avatarUrl
lengthOfDay
workingHoursId
workingHour
userRate
userCost
canAddProjects
- Name
fields[risks]
- Type
- array[string]
- Description
- Format
- Comma separated values
- Allowed values
id
source
probability
probabilityValue
impact
impactValue
impactCost
impactSchedule
impactPerformance
createdOn
createdByUserId
lastChangedOn
lastChangedByUserId
result
mitigationPlan
stats
projectId
deleted
canEdit
- Name
fields[projects]
- Type
- array[string]
- Description
- Format
- Comma separated values
- Allowed values
id
name
- Name
fields[companies]
- Type
- array[string]
- Description
- Format
- Comma separated values
- Allowed values
id
name
logoUploadedToServer
logoImage
Responses
- Code
- 200
- Type
- object
- Schema
- Description
- 200 OK
RisksResponse contains all the information returned when sending a GET request to the risk endpoint.
- Code
- 400
- Type
- object
- Schema
- Description
- 400 Bad Request
ErrorResponse defines how []Error should be marshaled to JSON.
- Code
- 403
- Type
- object
- Schema
- Description
- 403 Forbidden
ErrorResponse defines how []Error should be marshaled to JSON.
200 OK
{ "included": { "companies": { "additionalProp": { "accounts": 0, "addressOne": "string", "addressTwo": "string", "budgetDistribution": [ { "color": "string", "companyId": 0, "count": 0, "from": 0, "to": 0 } ], "canSeePrivate": true, "cid": "string",