ONonetrust
inventory-management-controller

Search Vendors by Name or Website

Use this API to search for vendors by name or website. At least one of name or website must be provided.

Example Request

GET https://{hostname}/api/inventory/v2/vendors/search?name=Acme

GET https://trial.onetrust.com/api/inventory/v2/vendors/search?website=acme.com

get/api/inventory/v2/vendors/search

Request

  • Base URL
    https://hostname
  • URL
    https://hostname/api/inventory/v2/vendors/search
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://{hostname}/api/access/v1/oauth/token scopes: INVENTORY, INVENTORY_READ, INVENTORY_WRITE

Query parameters

namestring

The vendor name to search for

websitestring

The vendor website to search for

orgGroupIdstring uuid

The organization group ID to scope the search

traversal'up' | 'down'

The organization traversal strategy

Response

OK - Successfully retrieved vendor search result.

idstring uuid
namestring
websitestring
matchType'NAME' | 'WEBSITE' | 'BOTH' | 'NONE'
vendorUrlstring

Changes

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