UPupguard
vendors

List all questionnaires

Returns a paginated list of all questionnaires across all vendors for the organization.

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

get/questionnaires/all/v1

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.

page_sizeinteger

Number of results per page (1-2000)

page_tokenstring

Token for the next page of results

sort_by'date_due' | 'vendor_name' | 'name' | 'status' | 'date_created' | 'date_completed'

Field to sort by. Allowed fields: date_due, vendor_name, name, status, date_created, date_completed.

sort_descboolean

Sort in descending order, sorts in ascending order if unset

statusstring

Comma-separated list of statuses to filter by. Allowed values: sent, opened, returned, inreview, complete, cancelled, published.

exclude_archivedboolean

If true, exclude archived questionnaires from results

Response

List of questionnaires across all vendors

next_page_tokenstring

Token for the next page of results

total_resultsinteger

The total number of matching results

Example response

{
  "questionnaires": [
    {
      "archived": true,
      "date_completed": "2022-04-15T10:30:00Z",
      "due_date": "2022-04-20T00:00:00Z",
      "id": 1,
      "name": "iso27001",
      "returned_at": "2022-03-20T23:23:37.228539Z",
      "sent_at": "2022-03-20T21:42:53.821938Z",
      "status": "complete",
      "vendor_hostname": "example.com",
      "vendor_id": 456,
      "vendor_name": "Example Corp"
    }
  ],
  "total_results": 42
}

Changes

No recorded changes to this operation across all 1 revision of this API.