UPupguard
risks

Get vendors affected by a risk

Returns a list of vendors that are affected by a specific risk. This endpoint provides detailed information about vendors that have failed a particular risk, including vendor details, risk information, and waiver status.

Required API key permissions: VendorRisk (select when creating API key in Account Settings)

get/risks/vendors_with_risk

Request

Query parameters

vendor_labelsstring[]

Filter on vendor labels using the label’s name. By default, any matching vendor will be returned. Use vendor_label_ids_match_all to require all labels to be present. If the label does not exist, 422 will be returned.

vendor_label_ids_match_allboolean

If true, will only return vendors that match ALL of the provided label IDs. If false or omitted, vendors matching ANY of the provided labels will be returned.

include_unlabeledboolean

If true, will include vendors that have no labels applied when vendor_label_ids is provided.

min_scoreinteger

Filter vendors to those with a score greater than or equal to this value. Valid range: 0-950.

max_scoreinteger

Filter vendors to those with a score less than or equal to this value. Valid range: 0-950.

name_prefixstring

Filter vendors whose name starts with the given prefix (case-insensitive).

vendor_idsinteger[]

Filter to only return vendors with the specified vendor IDs.

vendor_label_ids_do_not_matchboolean

If true, will only return vendors that DO NOT match ANY of the provided label IDs. This is mutually exclusive with vendor_label_ids_match_all.

vendor_tiersinteger[]

Filter watched vendors to those in the specified tiers. Valid values: 1-5.

portfoliosstring[]

Filter by portfolio IDs. Only vendors in these portfolios will be returned. If the portofilo does not exist, 422 will be returned.

assessed_vendors_onlyboolean

If true, will return only vendors with a published assessment.

questionnaire_type_idsinteger[]

Filter by questionnaire type IDs. Only vendors with these questionnaire types will be returned. Available questionnaire types can be found at /api/public/vendor/questionnaire_types.

vendor_date_added_startstring date-time

Start of date added range filter (RFC3339 format). Filters vendors added on or after this date.

vendor_date_added_endstring date-time

End of date added range filter (RFC3339 format). Filters vendors added on or before this date.

vendor_date_added_beforeboolean

If true, filter to vendors added before vendor_date_added_end.

vendor_date_added_betweenboolean

If true, filter to vendors added between start and end dates.

risk_idstring required

The risk_id to filter by

Response

OK

risk_idstring

The risk ID

risk_severitystring

The severity level of the risk (pass, info, low, medium, high, critical)

risk_typestring

The type of risk

total_vendors_matching_filterinteger

Total number of vendors matching the filter criteria

Changes

No recorded changes to this operation across all 2 revisions of this API.