page | number Default: 1 Which page of data are you requesting
Example: page=1 |
limit | number <= 50 Default: 20 How many items are your requesting
Example: limit=10 |
nextPage | string Example: nextPage=d2lraS9hcGkvdjIvcGFnZXM/bGltaXQ9MTAmY3Vyc29yPWV5SnBaQ0k2SWpJM05USTJPVGdpTENKamIyNTBSUGNtUmxjbFpoYkhWbElqb3lOelV5TmprNGZRPT0= |
q | string Filter data to search term
Example: q=Acme |
sort | string Which type of sort (default: NAME)
Enum: "CATEGORY" "NAME" "POLICY" "RISK" "USER" "TYPE" "STATUS" Example: sort=NAME |
sortDir | string Which direction to sort the data (default: ASC)
Enum: "ASC" "DESC" Example: sortDir=ASC |
category | string Filter data to vendors of this category
Enum: "ENGINEERING" "PRODUCT" "MARKETING" "CS" "SALES" "FINANCE" "HR" "ADMINISTRATIVE" "SECURITY" "LEGAL" "NONE" Example: category=ENGINEERING |
risk | string Filter data to vendors of this risk level
Enum: "NONE" "LOW" "MODERATE" "HIGH" Example: risk=MODERATE |
status | string Enum: "ACTIVE" "ARCHIVED" "APPROVED" "REJECTED" "FLAGGED" "ON_HOLD" "OFFBOARDED" "UNDER_REVIEW" "NONE" Example: status=UNDER_REVIEW |
critical | boolean Filter data to vendors depending on if it is considered critical
|
passwordPolicy | string Filter data to vendors with this password policy
Enum: "USERNAME_PASSWORD" "SSO" "LDAP" "NONE" Example: passwordPolicy=USERNAME_PASSWORD |
userId | number <= 1000000000 Filter data to a person responsible for vendors
Example: userId=1 |
withLastQuestionnaires | boolean Add last questionnaires to vendors
|
type | string Filter data to vendors of this type
Enum: "VENDOR" "SUPPLIER" "CONTRACTOR" "PARTNER" "OTHER" "NONE" Example: type=CONTRACTOR |
isArchived | boolean Get archived or unarchived vendors
|
renewalDate | string Example: renewalDate=2023-11-07 |
renewalScheduleType | string Vendor renewal schedule type
Enum: "ONE_MONTH" "TWO_MONTHS" "THREE_MONTHS" "SIX_MONTHS" "ONE_YEAR" "CUSTOM" Example: renewalScheduleType=ONE_YEAR |
renewalDateStatus | string Vendor renewal status based on how close it is to the renewal due date
Enum: "NO_RENEWAL" "COMPLETED" "RENEWAL_DUE_SOON" "RENEWAL_DUE" Example: renewalDateStatus=COMPLETED |
sharedAccountId | |