Provides access to the vendors that are part of a Hyperproof organization.
- Get Vendors Filtered
Vendors API (1.0)
- Mock serverhttps://developer.hyperproof.app/_mock/hyperproof-api/vendors/vendors.openapi
- Hyperproof UShttps://api.hyperproof.app/v1/vendors
- Hyperproof Govhttps://api.hyperproofgov.app/v1/vendors
- Hyperproof EUhttps://api.hyperproof.eu/v1/vendors
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://developer.hyperproof.app/_mock/hyperproof-api/vendors/vendors.openapi/?status=string' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'Success.
The unique identifier for the organization.
The unique identifier for the owner of the vendor.
The current state of the vendor.
The tolerance of the vendor.
The risk level of the vendor.
The numeric value associated with the assessed risk level.
The risk level of the vendor.
The unique identifier for the user who overrode the risk level.
The date when the risk level was overridden (ISO 8601 format).
The start date of the vendor contract (ISO 8601 format).
The end date of the vendor contract (ISO 8601 format).
The freshness policy of an object. Set to 'manual' with a 'freshAsOfDate' value otherwise 'freshness' will be set to 'unknown'.
The freshness status of an object. Cannot be set if 'freshnessPolicy' is 'none' and 'freshAsOfDate' is null.
The date when the vendor was last marked 'fresh'.
The note populated when the vendor was marked 'fresh'.
The unique identifier of the user who created the vendor.
The date the vendor was created (ISO-8601 format).
The unique identifier of the user who last updated the vendor.
The date the vendor was last updated (ISO-8601 format).
[ { "id": "f96d2b0c-9894-49ca-b26a-afd53268e760", "orgId": "f5cd56b9-6725-4d1a-88ad-e7486240fbd3", "name": "Hyperproof", "category": "Compliance", "ownerId": "e99e616e-6211-22ff-b755-633587729bf9", "vendorStatus": "approved", "tolerance": "high", "assessedRiskLevel": "moderate", "assessedRiskLevelValue": "", "riskLevel": "moderate", "riskLevelIsOverridden": false, "riskLevelOverrideReasoning": "", "riskLevelOverriddenBy": "e99e616e-6211-22ff-b755-633587729bf9", "riskLevelOverriddenOn": "2024-09-04T12:00:00.0000000+00:00", "contractStartDate": "2024-09-04T12:00:00.0000000+00:00", "contractEndDate": "2025-09-04T12:00:00.0000000+00:00", "freshnessPolicy": "manual", "freshForDuration": "PT720H", "freshness": "fresh", "freshAsOfDate": "2025-01-12T18:26:10.00.5365Z", "freshAsOfNote": "Initial freshness set", "customFields": [ … ], "contacts": [ … ], "createdBy": "82d7c228-8bcd-11e9-a94b-ab3de8494987", "createdOn": "2023-09-12T18:26:10.0053650+00:00", "updatedBy": "82d7c228-8bcd-11e9-a94b-ab3de8494987", "updatedOn": "2023-09-12T18:26:10.0053650+00:00", "status": "active" } ]
The unique identifier for the user who will be the owner of the vendor.
The current state of the vendor.
The tolerance of the vendor.
The start date of the vendor's contract.
The end date of the vendor's contract.
List of external contacts to associate with the vendor.
- Mock serverhttps://developer.hyperproof.app/_mock/hyperproof-api/vendors/vendors.openapi
- Hyperproof UShttps://api.hyperproof.app/v1/vendors
- Hyperproof Govhttps://api.hyperproofgov.app/v1/vendors
- Hyperproof EUhttps://api.hyperproof.eu/v1/vendors
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://developer.hyperproof.app/_mock/hyperproof-api/vendors/vendors.openapi/ \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"name": "Test Vendor from API",
"category": "API",
"ownerId": "e99e616e-6211-22ff-b755-633587729bf9",
"vendorStatus": "approved",
"tolerance": "high",
"riskLevel": "moderate",
"riskLevelIsOverridden": false,
"riskLevelOverriddenBy": "",
"contractStartDate": "2024-09-04T12:00:00.0000000+00:00",
"contractEndDate": "2025-09-04T12:00:00.0000000+00:00",
"contacts": [
{
"givenName": "Jane",
"surname": "Doe",
"email": "jane.doe@example.com"
}
],
"customFields": [
{
"fieldId": "ceb912ab-519b-11ee-a644-522476618ae8",
"textValue": "Antonio Moreno"
}
]
}'Success.
The unique identifier for the organization.
The unique identifier for the owner of the vendor.
The current state of the vendor.
The tolerance of the vendor.
The risk level of the vendor.
The numeric value associated with the assessed risk level.
The risk level of the vendor.
The unique identifier for the user who overrode the risk level.
The date when the risk level was overridden (ISO 8601 format).
The start date of the vendor contract (ISO 8601 format).
The end date of the vendor contract (ISO 8601 format).
The freshness policy of an object. Set to 'manual' with a 'freshAsOfDate' value otherwise 'freshness' will be set to 'unknown'.
The freshness status of an object. Cannot be set if 'freshnessPolicy' is 'none' and 'freshAsOfDate' is null.
The date when the vendor was last marked 'fresh'.
The note populated when the vendor was marked 'fresh'.
The unique identifier of the user who created the vendor.
The date the vendor was created (ISO-8601 format).
The unique identifier of the user who last updated the vendor.
The date the vendor was last updated (ISO-8601 format).
{ "id": "f96d2b0c-9894-49ca-b26a-afd53268e760", "orgId": "f5cd56b9-6725-4d1a-88ad-e7486240fbd3", "name": "Hyperproof", "category": "Compliance", "ownerId": "e99e616e-6211-22ff-b755-633587729bf9", "vendorStatus": "approved", "tolerance": "high", "assessedRiskLevel": "moderate", "assessedRiskLevelValue": "", "riskLevel": "moderate", "riskLevelIsOverridden": false, "riskLevelOverrideReasoning": "", "riskLevelOverriddenBy": "e99e616e-6211-22ff-b755-633587729bf9", "riskLevelOverriddenOn": "2024-09-04T12:00:00.0000000+00:00", "contractStartDate": "2024-09-04T12:00:00.0000000+00:00", "contractEndDate": "2025-09-04T12:00:00.0000000+00:00", "freshnessPolicy": "manual", "freshForDuration": "PT720H", "freshness": "fresh", "freshAsOfDate": "2025-01-12T18:26:10.00.5365Z", "freshAsOfNote": "Initial freshness set", "customFields": [ { … } ], "contacts": [ { … } ], "createdBy": "82d7c228-8bcd-11e9-a94b-ab3de8494987", "createdOn": "2023-09-12T18:26:10.0053650+00:00", "updatedBy": "82d7c228-8bcd-11e9-a94b-ab3de8494987", "updatedOn": "2023-09-12T18:26:10.0053650+00:00", "status": "active" }
List of unique identifiers of the vendors to update.
The category of the vendor. If set, clearCategory must not be set. If set to an empty string, the category will be cleared.
The unique identifier for the user who will be the owner of the vendor.
The unique identifier of the group to assign to the vendor. If set, clearGroupId must not be set.
Clears the group unique identifier if true. If set, groupId must not be set.
The current state of the vendor.
The tolerance of the vendor.
The risk level of the vendor.
Flag indicating whether the calculated risk level has been overridden.
The reasoning provided for overriding the calculated risk level.
The start date of the vendor's contract. If set, clearContractStartDate must not be set.
The end date of the vendor's contract. If set, clearContractEndDate must not be set.
Clears the contract start date if 'true'. If set, contractStartDate must not be set.
Clears the contract end date if 'true'. If set, contractEndDate must not be set.
The freshness policy of an object. Set to 'manual' with a 'freshAsOfDate' value otherwise 'freshness' will be set to 'unknown'.
Sets the duration after which the vendor becomes stale. Supply as a string in standard ISO-8601 duration format ex: P1Y3M2D or PT720H.
The freshness status of an object. Cannot be set if 'freshnessPolicy' is 'none' and 'freshAsOfDate' is null.
The date when the vendor is being marked 'fresh'.
The note to populate when the vendor is marked 'fresh'.
- Mock serverhttps://developer.hyperproof.app/_mock/hyperproof-api/vendors/vendors.openapi
- Hyperproof UShttps://api.hyperproof.app/v1/vendors
- Hyperproof Govhttps://api.hyperproofgov.app/v1/vendors
- Hyperproof EUhttps://api.hyperproof.eu/v1/vendors
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PATCH \
https://developer.hyperproof.app/_mock/hyperproof-api/vendors/vendors.openapi/ \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"vendorIds": [
"string"
],
"patch": {
"name": "Test Vendor from API Update",
"category": "API Category 2",
"ownerId": "e99e616e-6211-22ff-b755-633587729bf9",
"vendorStatus": "approved",
"tolerance": "high",
"riskLevel": "moderate",
"riskLevelIsOverridden": false,
"riskLevelOverriddenBy": "",
"contractStartDate": "2024-09-04T12:00:00.0000000+00:00",
"contractEndDate": "2025-09-04T12:00:00.0000000+00:00",
"freshnessPolicy": "manual",
"freshForDuration": "PT720H",
"freshness": "fresh",
"freshAsOfDate": "2025-01-12T18:26:10.00.5365Z",
"freshAsOfNote": "Updating expired vendor freshness",
"status": "active",
"customFields": [
{
"fieldId": "ceb912ab-519b-11ee-a644-522476618ae8",
"textValue": "Antonio Moreno"
}
]
}
}'Success.
The unique identifier for the organization.
The unique identifier for the owner of the vendor.
The current state of the vendor.
The tolerance of the vendor.
The risk level of the vendor.
The numeric value associated with the assessed risk level.
The risk level of the vendor.
The unique identifier for the user who overrode the risk level.
The date when the risk level was overridden (ISO 8601 format).
The start date of the vendor contract (ISO 8601 format).
The end date of the vendor contract (ISO 8601 format).
The freshness policy of an object. Set to 'manual' with a 'freshAsOfDate' value otherwise 'freshness' will be set to 'unknown'.
The freshness status of an object. Cannot be set if 'freshnessPolicy' is 'none' and 'freshAsOfDate' is null.
The date when the vendor was last marked 'fresh'.
The note populated when the vendor was marked 'fresh'.
The unique identifier of the user who created the vendor.
The date the vendor was created (ISO-8601 format).
The unique identifier of the user who last updated the vendor.
The date the vendor was last updated (ISO-8601 format).
{ "id": "f96d2b0c-9894-49ca-b26a-afd53268e760", "orgId": "f5cd56b9-6725-4d1a-88ad-e7486240fbd3", "name": "Hyperproof", "category": "Compliance", "ownerId": "e99e616e-6211-22ff-b755-633587729bf9", "vendorStatus": "approved", "tolerance": "high", "assessedRiskLevel": "moderate", "assessedRiskLevelValue": "", "riskLevel": "moderate", "riskLevelIsOverridden": false, "riskLevelOverrideReasoning": "", "riskLevelOverriddenBy": "e99e616e-6211-22ff-b755-633587729bf9", "riskLevelOverriddenOn": "2024-09-04T12:00:00.0000000+00:00", "contractStartDate": "2024-09-04T12:00:00.0000000+00:00", "contractEndDate": "2025-09-04T12:00:00.0000000+00:00", "freshnessPolicy": "manual", "freshForDuration": "PT720H", "freshness": "fresh", "freshAsOfDate": "2025-01-12T18:26:10.00.5365Z", "freshAsOfNote": "Initial freshness set", "customFields": [ { … } ], "contacts": [ { … } ], "createdBy": "82d7c228-8bcd-11e9-a94b-ab3de8494987", "createdOn": "2023-09-12T18:26:10.0053650+00:00", "updatedBy": "82d7c228-8bcd-11e9-a94b-ab3de8494987", "updatedOn": "2023-09-12T18:26:10.0053650+00:00", "status": "active" }
- Mock serverhttps://developer.hyperproof.app/_mock/hyperproof-api/vendors/vendors.openapi/filter
- Hyperproof UShttps://api.hyperproof.app/v1/vendors/filter
- Hyperproof Govhttps://api.hyperproofgov.app/v1/vendors/filter
- Hyperproof EUhttps://api.hyperproof.eu/v1/vendors/filter
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
https://developer.hyperproof.app/_mock/hyperproof-api/vendors/vendors.openapi/filter \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"vendorIds": [
"string"
]
}'Success.
The unique identifier for the organization.
The unique identifier for the owner of the vendor.
The current state of the vendor.
The tolerance of the vendor.
The risk level of the vendor.
The numeric value associated with the assessed risk level.
The risk level of the vendor.
The unique identifier for the user who overrode the risk level.
The date when the risk level was overridden (ISO 8601 format).
The start date of the vendor contract (ISO 8601 format).
The end date of the vendor contract (ISO 8601 format).
The freshness policy of an object. Set to 'manual' with a 'freshAsOfDate' value otherwise 'freshness' will be set to 'unknown'.
The freshness status of an object. Cannot be set if 'freshnessPolicy' is 'none' and 'freshAsOfDate' is null.
The date when the vendor was last marked 'fresh'.
The note populated when the vendor was marked 'fresh'.
The unique identifier of the user who created the vendor.
The date the vendor was created (ISO-8601 format).
The unique identifier of the user who last updated the vendor.
The date the vendor was last updated (ISO-8601 format).
[ { "id": "f96d2b0c-9894-49ca-b26a-afd53268e760", "orgId": "f5cd56b9-6725-4d1a-88ad-e7486240fbd3", "name": "Hyperproof", "category": "Compliance", "ownerId": "e99e616e-6211-22ff-b755-633587729bf9", "vendorStatus": "approved", "tolerance": "high", "assessedRiskLevel": "moderate", "assessedRiskLevelValue": "", "riskLevel": "moderate", "riskLevelIsOverridden": false, "riskLevelOverrideReasoning": "", "riskLevelOverriddenBy": "e99e616e-6211-22ff-b755-633587729bf9", "riskLevelOverriddenOn": "2024-09-04T12:00:00.0000000+00:00", "contractStartDate": "2024-09-04T12:00:00.0000000+00:00", "contractEndDate": "2025-09-04T12:00:00.0000000+00:00", "freshnessPolicy": "manual", "freshForDuration": "PT720H", "freshness": "fresh", "freshAsOfDate": "2025-01-12T18:26:10.00.5365Z", "freshAsOfNote": "Initial freshness set", "customFields": [ … ], "contacts": [ … ], "createdBy": "82d7c228-8bcd-11e9-a94b-ab3de8494987", "createdOn": "2023-09-12T18:26:10.0053650+00:00", "updatedBy": "82d7c228-8bcd-11e9-a94b-ab3de8494987", "updatedOn": "2023-09-12T18:26:10.0053650+00:00", "status": "active" } ]
- Mock serverhttps://developer.hyperproof.app/_mock/hyperproof-api/vendors/vendors.openapi/{vendorId}
- Hyperproof UShttps://api.hyperproof.app/v1/vendors/{vendorId}
- Hyperproof Govhttps://api.hyperproofgov.app/v1/vendors/{vendorId}
- Hyperproof EUhttps://api.hyperproof.eu/v1/vendors/{vendorId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://developer.hyperproof.app/_mock/hyperproof-api/vendors/vendors.openapi/{vendorId}' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'Success.
The unique identifier for the organization.
The unique identifier for the owner of the vendor.
The current state of the vendor.
The tolerance of the vendor.
The risk level of the vendor.
The numeric value associated with the assessed risk level.
The risk level of the vendor.
The unique identifier for the user who overrode the risk level.
The date when the risk level was overridden (ISO 8601 format).
The start date of the vendor contract (ISO 8601 format).
The end date of the vendor contract (ISO 8601 format).
The freshness policy of an object. Set to 'manual' with a 'freshAsOfDate' value otherwise 'freshness' will be set to 'unknown'.
The freshness status of an object. Cannot be set if 'freshnessPolicy' is 'none' and 'freshAsOfDate' is null.
The date when the vendor was last marked 'fresh'.
The note populated when the vendor was marked 'fresh'.
The unique identifier of the user who created the vendor.
The date the vendor was created (ISO-8601 format).
The unique identifier of the user who last updated the vendor.
The date the vendor was last updated (ISO-8601 format).
{ "id": "f96d2b0c-9894-49ca-b26a-afd53268e760", "orgId": "f5cd56b9-6725-4d1a-88ad-e7486240fbd3", "name": "Hyperproof", "category": "Compliance", "ownerId": "e99e616e-6211-22ff-b755-633587729bf9", "vendorStatus": "approved", "tolerance": "high", "assessedRiskLevel": "moderate", "assessedRiskLevelValue": "", "riskLevel": "moderate", "riskLevelIsOverridden": false, "riskLevelOverrideReasoning": "", "riskLevelOverriddenBy": "e99e616e-6211-22ff-b755-633587729bf9", "riskLevelOverriddenOn": "2024-09-04T12:00:00.0000000+00:00", "contractStartDate": "2024-09-04T12:00:00.0000000+00:00", "contractEndDate": "2025-09-04T12:00:00.0000000+00:00", "freshnessPolicy": "manual", "freshForDuration": "PT720H", "freshness": "fresh", "freshAsOfDate": "2025-01-12T18:26:10.00.5365Z", "freshAsOfNote": "Initial freshness set", "customFields": [ { … } ], "contacts": [ { … } ], "createdBy": "82d7c228-8bcd-11e9-a94b-ab3de8494987", "createdOn": "2023-09-12T18:26:10.0053650+00:00", "updatedBy": "82d7c228-8bcd-11e9-a94b-ab3de8494987", "updatedOn": "2023-09-12T18:26:10.0053650+00:00", "status": "active" }
The category of the vendor. If set, clearCategory must not be set. If set to an empty string, the category will be cleared.
The unique identifier for the user who will be the owner of the vendor.
The unique identifier of the group to assign to the vendor. If set, clearGroupId must not be set.
The current state of the vendor.
The tolerance of the vendor.
The risk level of the vendor.
Flag indicating whether the calculated risk level has been overridden.
The reasoning provided for overriding the calculated risk level.
The start date of the vendor's contract. If set, clearContractStartDate must not be set.
The end date of the vendor's contract. If set, clearContractEndDate must not be set.
Clears the contract start date if 'true'. If set, contractStartDate must not be set.
Clears the contract end date if 'true'. If set, contractEndDate must not be set.
The freshness policy of an object. Set to 'manual' with a 'freshAsOfDate' value otherwise 'freshness' will be set to 'unknown'.
Sets the duration after which the vendor becomes stale. Supply as a string in standard ISO-8601 duration format ex: P1Y3M2D or PT720H.
The freshness status of an object. Cannot be set if 'freshnessPolicy' is 'none' and 'freshAsOfDate' is null.
The date when the vendor is being marked 'fresh'.
The note to populate when the vendor is marked 'fresh'.
- Mock serverhttps://developer.hyperproof.app/_mock/hyperproof-api/vendors/vendors.openapi/{vendorId}
- Hyperproof UShttps://api.hyperproof.app/v1/vendors/{vendorId}
- Hyperproof Govhttps://api.hyperproofgov.app/v1/vendors/{vendorId}
- Hyperproof EUhttps://api.hyperproof.eu/v1/vendors/{vendorId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PATCH \
'https://developer.hyperproof.app/_mock/hyperproof-api/vendors/vendors.openapi/{vendorId}' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"name": "Test Vendor from API Update",
"category": "API Category 2",
"ownerId": "e99e616e-6211-22ff-b755-633587729bf9",
"vendorStatus": "approved",
"tolerance": "high",
"riskLevel": "moderate",
"riskLevelIsOverridden": false,
"riskLevelOverriddenBy": "",
"contractStartDate": "2024-09-04T12:00:00.0000000+00:00",
"contractEndDate": "2025-09-04T12:00:00.0000000+00:00",
"freshnessPolicy": "manual",
"freshForDuration": "PT720H",
"freshness": "fresh",
"freshAsOfDate": "2025-01-12T18:26:10.00.5365Z",
"freshAsOfNote": "Updating expired vendor freshness",
"status": "active",
"customFields": [
{
"fieldId": "ceb912ab-519b-11ee-a644-522476618ae8",
"textValue": "Antonio Moreno"
}
]
}'Success.
The unique identifier for the organization.
The unique identifier for the owner of the vendor.
The current state of the vendor.
The tolerance of the vendor.
The risk level of the vendor.
The numeric value associated with the assessed risk level.
The risk level of the vendor.
The unique identifier for the user who overrode the risk level.
The date when the risk level was overridden (ISO 8601 format).
The start date of the vendor contract (ISO 8601 format).
The end date of the vendor contract (ISO 8601 format).
The freshness policy of an object. Set to 'manual' with a 'freshAsOfDate' value otherwise 'freshness' will be set to 'unknown'.
The freshness status of an object. Cannot be set if 'freshnessPolicy' is 'none' and 'freshAsOfDate' is null.
The date when the vendor was last marked 'fresh'.
The note populated when the vendor was marked 'fresh'.
The unique identifier of the user who created the vendor.
The date the vendor was created (ISO-8601 format).
The unique identifier of the user who last updated the vendor.
The date the vendor was last updated (ISO-8601 format).
{ "id": "f96d2b0c-9894-49ca-b26a-afd53268e760", "orgId": "f5cd56b9-6725-4d1a-88ad-e7486240fbd3", "name": "Hyperproof", "category": "Compliance", "ownerId": "e99e616e-6211-22ff-b755-633587729bf9", "vendorStatus": "approved", "tolerance": "high", "assessedRiskLevel": "moderate", "assessedRiskLevelValue": "", "riskLevel": "moderate", "riskLevelIsOverridden": false, "riskLevelOverrideReasoning": "", "riskLevelOverriddenBy": "e99e616e-6211-22ff-b755-633587729bf9", "riskLevelOverriddenOn": "2024-09-04T12:00:00.0000000+00:00", "contractStartDate": "2024-09-04T12:00:00.0000000+00:00", "contractEndDate": "2025-09-04T12:00:00.0000000+00:00", "freshnessPolicy": "manual", "freshForDuration": "PT720H", "freshness": "fresh", "freshAsOfDate": "2025-01-12T18:26:10.00.5365Z", "freshAsOfNote": "Initial freshness set", "customFields": [ { … } ], "contacts": [ { … } ], "createdBy": "82d7c228-8bcd-11e9-a94b-ab3de8494987", "createdOn": "2023-09-12T18:26:10.0053650+00:00", "updatedBy": "82d7c228-8bcd-11e9-a94b-ab3de8494987", "updatedOn": "2023-09-12T18:26:10.0053650+00:00", "status": "active" }