Retrieve My Vendors
GET
/vendors
Fetches all vendors associated with your company. Optional filters can be applied for keyword, status, and compliance status.
Authorizations
bearer
TypeHTTP (bearer)
Parameters
Query Parameters
keyword
A search term to filter vendors by name or other relevant fields.
Typestring
status
Filter vendors by their status (e.g., 'active', 'invited', 'inactive').
Typestring
Enum
CURRENT_VENDOR
INVITED_VENDOR
complianceStatus
Filter vendors by compliance status (e.g., 'compliant', 'non-compliant', 'unknown').
Typestring
Enum
COMPLIANT
NONCOMPLIANT
PENDING
INVITED
Responses
A list of vendors matching the filters
application/json
JSON
[
{
"vendorURL": "string",
"metadata": {
},
"id": 0,
"complianceStatus": "string",
"vendorStatus": "string",
"lastComplianceUpdate": "string",
"lastComplianceRefresh": "string",
"checklist": [
{
"documentURL": "string",
"errorMessages": [
"string"
],
"type": "string",
"compliant": true,
"status": "string",
"documentId": 0
}
]
}
]