The Third-Party Risk Management APIs provide comprehensive functionality for managing vendor relatio nships, engagements, and contracts within the GRC ecosystem, enabling organizations to assess, monit or, and control third-party risks through engagement lifecycle management, contract administration, and customizable attribute schemas. (15 operations.)
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/third-party-management-third-party-risk-management"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
{"openapi":"3.1.0","info":{"title":"Third-Party Management - Third-Party Risk Management","version":"1.0","contact":{"name":"OneTrust Support","url":"https://my.onetrust.com/s/contactsupport"},"license":{"name":"Apache 2.0","url":"https://www.apache.org/licenses/LICENSE-2.0"},"description":"The Third-Party Risk Management APIs provide comprehensive functionality for managing vendor relationships, engagements, and contracts within the GRC ecosystem, enabling organizations to assess, monitor, and control third-party risks through engagement lifecycle management, contract administration, and customizable attribute schemas."},"servers":[{"url":"https://{hostname}","variables":{"hostname":{"default":"hostname","description":"The OneTrust hostname such as app.onetrust.com, app-eu.onetrust.com, app-de.onetrust.com, app-uk.onetrust.com, app-apac.onetrust.com, trial.onetrust.com, or uat.onetrust.com."}}}],"tags":[{"name":"Contracts","description":"The Contracts APIs are used to manage vendor contract operations including contract creation, updates, search functionality, contract type management, and schema configuration for comprehensive contract lifecycle management.","externalDocs":{"description":"OpenAPI 3.1.0 - Download Definition","url":"https://developer.onetrust.com/onetrust/openapi/third-party-management-third-party-risk-management.json"}},{"name":"Engagements","description":"The Engagements APIs are used to manage vendor engagement operations including creating, retrieving, updating, and searching engagements with comprehensive attribute management, status control, workflow integration, and schema configuration capabilities.","externalDocs":{"description":"OpenAPI 3.1.0 - Download Definition","url":"https://developer.onetrust.com/onetrust/openapi/third-party-management-third-party-risk-management.json"}}],"x-onetrust":{"spec-label":"OpenAPI 3.1.0","links":["{'Third-Party Risk Management Knowledge Base': 'https://my.onetrust.com/s/topic/0TO1Q000000ItS2WAK/thirdparty-risk-management'}"]},"x-readme":{"explorer-enabled":false,"proxy-enabled":false,"metrics-enabled":false},"paths":{"/api/vendor/v1/contracts/add":{"post":{"operationId":"createVendorContractUsingPOST","summary":"Create Contract","description":"Use this API to create a new contract.\n\n","tags":["Contracts"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/third-party-management-third-party-risk-management.json"},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalContractCreateRequest"},"example":{"orgGroupId":"a41972ae-2050-4126-b314-1a58d08ea116","name":"Microsoft Contract","vendorId":"1a4e74d8-4ba9-4b05-8dc5-94cbbeb48a1c","vendorName":"Microsoft","status":"IN_PROGRESS","agreementCreatedDate":"2023-05-15","expirationDate":"2023-05-16","approvedDate":"2023-05-16","attachments":[],"contractTypeName":"Master Service Agreement","vendorContact":"vendorcontact@microsoft.com","approvers":"jk@microsoft.com","note":"Contract for Microsoft vendor","cost":"12000","currency":"USD","attributeValues":{"attributeSingleSelectValue.value21":[{"id":"c5c3167e-f8e2-4719-a0a1-491350507fee","valueKey":"OneTrustApp.VRM.Contract.Attributes.e38d9fe7-a5b7-43b0-b79f-ed7940669c99","value":"Headquarters-Atlanta"}]},"engagementIds":[],"assets":[{"inventoryId":"58ff1c0b-be17-40be-885e-b97e1b9450af"}],"vendors":[{"inventoryId":"8f230244-d3e9-4cf3-8303-ce19e7be8899","relationshipType":"RelatedLinkType"}],"processingActivities":[{"inventoryId":"f4f71778-2345-4e21-a6b4-e69a24ef12cd"}]}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"description":"The unique identifier (contractId) of the created contract.","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["GENERIC","VRM"]}]}},"/api/vendor/v1/contracts/schemas":{"get":{"operationId":"getContractSchemaUsingGET","summary":"Get Contract Schema","description":"Use this API to retrieve the schema for contract attributes. The response will include details such as the attribute name, ID, and associated options.","tags":["Contracts"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/third-party-management-third-party-risk-management.json"},"parameters":[{"name":"activeStatus","in":"query","description":"The flag to indicate if only 'Active' status attributes need to be returned or not.","required":false,"schema":{"type":"boolean","example":true,"default":true}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AttributeInformation"}},"example":[{"id":"2090ff08-25ca-4bc9-a721-8cd50264c7c7","name":"Approved Date","nameKey":"ContractApprovedDate","description":"ApprovedDate","descriptionKey":"ContractApprovedDate.Description","fieldName":"approvedDate","mappedFieldName":"approvedDate","enabled":true,"required":false,"readOnly":false,"encrypted":false,"allowOther":false,"baseAttribute":true,"responseType":"Date","formula":null,"optionType":"none","optionAllowed":false,"schemaId":"36e2d4a1-379f-4263-8e05-6e3a3207a834","schemaName":"ContractSchema","responseMaxLength":null,"source":null,"responseSubType":null,"multiSelectMaxOptionValues":null,"hidden":false}]}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["GENERIC","VRM","VRM_READ"]}]}},"/api/vendor/v1/contracts/types":{"get":{"operationId":"fetchAllContractTypesUsingGET","summary":"Get List of Contract Types","description":"Use this API to retrieve a list of all contract types.","tags":["Contracts"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/third-party-management-third-party-risk-management.json"},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ContractTypeInformation"}},"example":[{"id":"be71591d-5475-4a74-9a53-e015e5b4053e","name":"Data Master Service Agreement","nameKey":null,"enabled":true,"seeded":false},{"id":"50bff9bb-1cf8-48e7-b8e7-14000526c226","name":"Data Processing Agreement","nameKey":"DataProcessingAgreement","enabled":true,"seeded":true},{"id":"0e67da47-2ab6-4f03-8aeb-623768bb41c9","name":"End User Licensing Agreement","nameKey":"EndUserLicensingAgreement","enabled":true,"seeded":true},{"id":"7e7f532b-2427-4f45-84f4-67bdb24c5831","name":"Master Service Agreement","nameKey":"MasterServiceAgreement","enabled":true,"seeded":true},{"id":"3a4d3855-fe68-446d-99e3-90897ab1cc17","name":"Privacy Policy","nameKey":"PrivacyPolicy","enabled":true,"seeded":true},{"id":"6a452a47-3cb6-44d8-9112-e46a4b0a12c3","name":"Privacy type","nameKey":"PrivacyType","enabled":true,"seeded":true},{"id":"50d6f3b4-0767-405d-9c23-867f8d2b2c22","name":"Purchase Agreement","nameKey":"PurchaseAgreement","enabled":true,"seeded":true},{"id":"7eb0d149-61d4-4d15-8b73-db34efbabe1b","name":"Statement of Work","nameKey":"StatementOfWork","enabled":true,"seeded":true},{"id":"118a892f-c0cf-4856-b1b2-83aecbee3758","name":"Unknown","nameKey":"Unknown","enabled":true,"seeded":true}]}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["GENERIC","VRM","VRM_READ"]}]}},"/api/vendor/v1/contracts/vendors/{vendorId}/contracts":{"post":{"operationId":"searchContractByVendorAndCriteriaUsingPOST","summary":"Search Contracts","description":"Use this API to search for contracts associated with a specific vendor by key terms and filters.","tags":["Contracts"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/third-party-management-third-party-risk-management.json"},"parameters":[{"name":"vendorId","in":"path","description":"The unique identifier of the vendor. The value can be obtained using [List Vendors](/onetrust/reference/getlistofinventoriesusingget-1) API.","required":true,"schema":{"type":"string","format":"uuid","example":"4d5c76e1-afa3-4d24-a412-c7eadd63cc75"}},{"name":"page","in":"query","description":"Page number of the results list (0…N).","schema":{"type":"integer","format":"int32","example":0,"default":0}},{"name":"size","in":"query","description":"Number of records per page (1…N).","schema":{"type":"integer","format":"int32","example":20,"default":20,"maximum":2000,"minimum":1}},{"name":"sort","in":"query","description":"Returns the contracts list in sorted order. Returns records in ascending order by contract name by default.","schema":{"type":"string","example":"name,asc","default":"name,asc"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchCriteriaInformation"},"example":{"filters":[{"field":"contractTypeName","operator":"EQUAL_TO","value":["Privacy Policy"]}],"fullText":"Microsoft Contract"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/PageVendorContractListInformation"},"example":{"content":[{"agreementCreatedDate":"2023-05-16T00:00:00.000+00:00","approvedDate":"2023-05-16","approvers":"amara@microsoft.com","attachments":[],"attributeValues":{"attributeSingleSelectValue.value21":[{"id":"c5c3167e-f8e2-4719-a0a1-491350507fee","valueKey":"OneTrustApp.VRM.Contract.Attributes.e38d9fe7-a5b7-43b0-b79f-ed7940669c99","value":"Recently Updated"}]},"contractOwner":"Antonio","contractOwnerId":"8a732373-9713-4f93-98f6-cae431e61956","contractTypeId":"3a4d3855-fe68-446d-99e3-90897ab1cc17","contractTypeName":"Privacy Policy","contractTypeNameKey":"PrivacyPolicy","cost":10000,"currency":"INR","expirationDate":"2023-05-16","id":"db3398d0-cbce-4796-b248-614661cf256b","name":"Microsoft Contract","note":"Contract has been updated recently for Microsoft vendor","orgGroupId":"a41972ae-2050-4126-b314-1a58d08ea116","schemaId":"36e2d4a1-379f-4263-8e05-6e3a3207a834","status":"NEW","statusKey":"New","url":"https://www.microsoft.com","vendorContact":"antanio@microsoft.com","vendorId":"5ec48d61-1562-43ad-87a3-6fc7073494af","vendorName":"Microsoft","viewOnly":false}],"first":true,"last":true,"number":0,"numberOfElements":1,"size":20,"sort":{"sorted":true,"unsorted":false,"empty":false},"totalElements":1,"totalPages":1,"empty":false}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["GENERIC","VRM","VRM_READ"]}]}},"/api/vendor/v1/contracts/{contractId}":{"delete":{"operationId":"removeVendorContractUsingDELETE","summary":"Delete Contract","description":"Use this API to delete an existing contract.","tags":["Contracts"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/third-party-management-third-party-risk-management.json"},"parameters":[{"name":"contractId","in":"path","description":"The unique identifier of the contract.","required":true,"schema":{"type":"string","format":"uuid","example":"fbf7843d-bc3c-4ad7-86c7-f6c9a94e873e"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["GENERIC","VRM"]}]}},"/api/vendor/v1/contracts/{contractId}/contracts":{"get":{"operationId":"loadVendorContractByContractIdUsingGET","summary":"Get Contract","description":"Use this API to retrieve a single contract by its unique identifier. The response will include details such as the created date, approved date, and corresponding approvers.","tags":["Contracts"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/third-party-management-third-party-risk-management.json"},"parameters":[{"name":"contractId","in":"path","description":"The unique identifier of the contract.","required":true,"schema":{"type":"string","format":"uuid","example":"db3398d0-cbce-4796-b248-614661cf256b"}},{"name":"excludeAttachments","in":"query","description":"The flag to indicate if the `attachments` list shall be returned in the response.","required":false,"schema":{"type":"boolean","example":false,"default":false}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VendorContractInformation"},"example":{"id":"db3398d0-cbce-4796-b248-614661cf256b","name":"Microsoft Contract","vendorId":"5ec48d61-1562-43ad-87a3-6fc7073494af","vendorName":"Microsoft","orgGroupId":"a41972ae-2050-4126-b314-1a58d08ea116","attachments":[],"status":"NEW","agreementCreatedDate":"2023-05-16T00:00:00.000+00:00","contractTypeId":"3a4d3855-fe68-446d-99e3-90897ab1cc17","contractTypeName":"Privacy Policy","contractTypeNameKey":"PrivacyPolicy","approvedDate":"2023-05-16","expirationDate":"2023-05-16","contractOwnerId":"8a732373-9713-4f93-98f6-cae431e61956","contractOwner":"Antonio","vendorContact":"antanio@microsoft.com","approvers":"amara@microsoft.com","note":"Contract has been updated recently for Microsoft vendor","cost":10000,"currency":"INR","url":"https://www.microsoft.com","schemaId":"36e2d4a1-379f-4263-8e05-6e3a3207a834","attributeValues":{"attributeSingleSelectValue.value21":[{"id":"c5c3167e-f8e2-4719-a0a1-491350507fee","valueKey":"OneTrustApp.VRM.Contract.Attributes.e38d9fe7-a5b7-43b0-b79f-ed7940669c99","value":"Recently Updated"}]},"viewOnly":false,"statusKey":"New"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["GENERIC","VRM","VRM_READ"]}]}},"/api/vendor/v1/contracts/{contractId}/vendors/{vendorId}/contracts":{"put":{"operationId":"updateVendorContractUsingPUT","summary":"Update Contract","description":"Use this API to update an existing contract.","tags":["Contracts"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/third-party-management-third-party-risk-management.json"},"parameters":[{"name":"contractId","in":"path","description":"The unique identifier of the contract. The value can be obtained using [Get All Eligible Contract Types, Order by Name](/onetrust/reference/fetchallcontracttypesusingget) API.","required":true,"schema":{"type":"string","format":"uuid","example":"4d5c76e1-afa3-4d24-a412-c7eadd63cc75"}},{"name":"vendorId","in":"path","description":"The unique identifier of the vendor. The value can be obtained using [List Vendors](/onetrust/reference/getlistofinventoriesusingget-1) API.","required":true,"schema":{"type":"string","format":"uuid","example":"5c5c76e1-afa3-4d24-a412-c7eadd63cc75"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VendorContractUpdateRequest"},"example":{"id":"db3398d0-cbce-4796-b248-614661cf256b","name":"Microsoft Contract","vendorId":"5ec48d61-1562-43ad-87a3-6fc7073494af","vendorName":"Microsoft","orgGroupId":"a41972ae-2050-4126-b314-1a58d08ea116","attachments":[],"status":"NEW","agreementCreatedDate":"2023-05-16T00:00:00.000+00:00","contractTypeId":"3a4d3855-fe68-446d-99e3-90897ab1cc17","contractTypeName":"Privacy Policy","contractTypeNameKey":"PrivacyPolicy","approvedDate":"2023-05-16","expirationDate":"2023-05-16","contractOwnerId":"8a732373-9713-4f93-98f6-cae431e61956","contractOwner":"Antonio","vendorContact":"antanio@microsoft.com","approvers":"amara@microsoft.com","note":"Contract has been updated recently for Microsoft vendor","cost":10000,"currency":"INR","url":"https://www.microsoft.com","schemaId":"36e2d4a1-379f-4263-8e05-6e3a3207a834","attributeValues":{"attributeSingleSelectValue.value21":[{"id":"c5c3167e-f8e2-4719-a0a1-491350507fee","valueKey":"OneTrustApp.VRM.Contract.Attributes.e38d9fe7-a5b7-43b0-b79f-ed7940669c99","value":"Recently Updated"}]},"viewOnly":false,"statusKey":"New"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VendorContractInformation"},"example":{"id":"db3398d0-cbce-4796-b248-614661cf256b","name":"Microsoft Contract","vendorId":"5ec48d61-1562-43ad-87a3-6fc7073494af","vendorName":"Microsoft","orgGroupId":"a41972ae-2050-4126-b314-1a58d08ea116","attachments":[],"status":"NEW","agreementCreatedDate":"2023-05-16T00:00:00.000+00:00","contractTypeId":"3a4d3855-fe68-446d-99e3-90897ab1cc17","contractTypeName":"Privacy Policy","contractTypeNameKey":"PrivacyPolicy","approvedDate":"2023-05-16","expirationDate":"2023-05-16","contractOwnerId":"8a732373-9713-4f93-98f6-cae431e61956","contractOwner":"Antonio","vendorContact":"antanio@microsoft.com","approvers":"amara@microsoft.com","note":"Contract has been updated recently for Microsoft vendor","cost":10000,"url":"https://www.microsoft.com","schemaId":"36e2d4a1-379f-4263-8e05-6e3a3207a834","attributeValues":{"attributeSingleSelectValue.value21":[{"id":"c5c3167e-f8e2-4719-a0a1-491350507fee","valueKey":"OneTrustApp.VRM.Contract.Attributes.e38d9fe7-a5b7-43b0-b79f-ed7940669c99","value":"Recently Updated"}]},"viewOnly":false,"statusKey":"New"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["GENERIC","VRM"]}]}},"/api/vendor/v1/engagement-schemas":{"get":{"operationId":"getEngagementSchemaUsingGET","summary":"Get Engagement Schema","description":"Use this API to retrieve the schema for engagement attributes. The response will include details such as the attribute name, ID, and associated options.","tags":["Engagements"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/third-party-management-third-party-risk-management.json"},"parameters":[{"name":"activeStatus","in":"query","description":"The flag to indicate if only 'Active' status attributes need to be returned or not.","required":false,"schema":{"type":"boolean","example":true,"default":true}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AttributeInformation"}},"example":[{"id":"c782f1f1-a2eb-4c0e-b2eb-702fb60561f6","name":"Aggregate Risk Level","nameKey":"Engagement.AggregateRiskLevel","description":"Overall risk level associated with the engagement","descriptionKey":"Engagement.AggregateRiskLevel.Description","fieldName":"aggregateRiskLevel","mappedFieldName":"aggregateRiskLevel","enabled":true,"required":false,"readOnly":true,"encrypted":false,"allowOther":false,"baseAttribute":true,"responseType":"SingleSelect","formula":null,"optionType":"none","optionAllowed":true,"schemaId":"f724dce6-4918-46c9-a21e-b012306af158","schemaName":"EngagementSchema","responseMaxLength":null,"source":null,"responseSubType":null,"multiSelectMaxOptionValues":null,"hidden":false}]}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["GENERIC","VRM","VRM_READ"]}]}},"/api/vendor/v1/engagements/{engagementId}":{"get":{"operationId":"loadEngagementByEngagementIdUsingGet","summary":"Get Engagement","description":"Use this API to retrieve a single engagement by its unique identifier along with the associated vendor, workflow, and attributes.","tags":["Engagements"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/third-party-management-third-party-risk-management.json"},"parameters":[{"name":"engagementId","in":"path","description":"The unique identifier of an engagement. The value can be obtained using the [Get Engagements](/onetrust/reference/loadengagementusingget) API.","required":true,"schema":{"type":"string","format":"uuid","example":"41aa71ae-0ace-4073-8947-e6941714bcf1"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EngagementDetailInformation"},"example":{"engagementId":"5ab7eef6-997c-4e30-a628-1d30305f744f","name":"Microsoft Azure","orgGroupName":"Corporate","orgGroupId":"a41972ae-2050-4126-b314-1a58d08ea116","type":"VendorEngagement","startDate":"2023-05-10","endDate":"2023-05-11","internalOwnerId":"8a732373-9713-4f93-98f6-cae431e61956","internalOwnerUser":"tyler","internalOwnerEmail":"tyler@msft.com","externalContact":"External contact for Microsoft Office","notes":"This engagement is for Microsoft Office","scope":"License agreement for the IT business unit only","schemaId":"bfb03ce4-e214-4c99-84a0-87a253269495","vendor":{"id":"97e8d8d7-e05c-4e0a-beec-ef1458ea1ebc","name":"Microsoft","orgGroupId":"a41972ae-2050-4126-b314-1a58d08ea116","orgGroupName":"Corporate"},"workflow":{"id":"8ac1bf26-fa0d-43d2-9a1b-81130673030c","nameKey":"DefaultEngagementWorkflow","name":"Default Engagement Workflow","stageId":"c6ce7a8b-de4d-4707-924b-d283f273fe2c","stageNameKey":"New","stageName":"New","stageBadgeColor":"New"},"attributeValues":{"attributeSingleSelectValue.value21":[{"id":"c5c3167e-f8e2-4719-a0a1-491350507fee","value":"Azure Documentation","valueKey":"OneTrustApp.VRM.Engagement.Attributes.e38d9fe7-a5b7-43b0-b79f-ed7940669c99"}]},"viewOnly":false,"riskLevel":"MEDIUM","riskScore":2,"inherentRiskLevel":"MEDIUM","inherentRiskScore":2,"targetRiskLevel":"HIGH","targetRiskScore":2,"engagementStatus":"ACTIVE","lastUpdatedDate":"2023-05-10"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["GENERIC","VRM_READ"]}]},"put":{"operationId":"updateEngagementUsingPUT","summary":"Update Engagement","description":"Use this API to update an existing engagement.\n\n> 🗒 Things to Know\n> \n> - For date and time attributes, the formatting should follow the `YYYY-MM-DDTHH:MM:SSZ` format.\n> - An engagement's workflow or stage cannot be updated using this API.\n> - If the `orgGroupId` parameter is not passed in the request, the engagement will be created with the same organization assigned to the engagement's vendor. If the `orgGroupId` parameter value is invalid, then an invalid organization error will be sent.\n> - The name of the engagement must be 500 characters or less.","tags":["Engagements"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/third-party-management-third-party-risk-management.json"},"parameters":[{"name":"engagementId","in":"path","description":"The unique identifier of an engagement. The value can be obtained using the [Get Engagements](/onetrust/reference/loadengagementusingget) API.","required":true,"schema":{"type":"string","format":"uuid","example":"fbf7843d-bc3c-4ad7-86c7-f6c9a94e873e"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalEngagementUpdateRequest"},"example":{"notes":"This engagement is for Microsoft Office","endDate":"2023-05-11","orgGroupId":"a41972ae-2050-4126-b314-1a58d08ea116","internalOwnerEmail":"tyler@msft.com","scope":"License agreement for the IT business unit only.","name":"Microsoft Azure","attributeValues":{"attributeSingleSelectValue.value21":[{"id":"c5c3167e-f8e2-4719-a0a1-491350507fee","valueKey":"OneTrustApp.VRM.Engagement.Attributes.e38d9fe7-a5b7-43b0-b79f-ed7940669c99","value":"Azure Documentation"}]},"externalContact":"External contact for Microsoft Office","type":"VendorEngagement","startDate":"2023-05-10"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EngagementDetailInformation"},"example":{"engagementId":"5ab7eef6-997c-4e30-a628-1d30305f744f","name":"Microsoft Azure","orgGroupName":"Corporate","orgGroupId":"a41972ae-2050-4126-b314-1a58d08ea116","type":"VendorEngagement","startDate":"2023-05-10","endDate":"2023-05-11","internalOwnerId":"8a732373-9713-4f93-98f6-cae431e61956","internalOwnerUser":"tyler@msft.com","externalContact":"External contact for Microsoft Office","notes":"This engagement is for Microsoft Office","scope":"License agreement for the IT business unit only","schemaId":"bfb03ce4-e214-4c99-84a0-87a253269495","vendor":{"id":"97e8d8d7-e05c-4e0a-beec-ef1458ea1ebc","name":"Microsoft","orgGroupId":"a41972ae-2050-4126-b314-1a58d08ea116","orgGroupName":"Corporate"},"workflow":{"id":"8ac1bf26-fa0d-43d2-9a1b-81130673030c","nameKey":"DefaultEngagementWorkflow","name":"Default Engagement Workflow","stageId":"c6ce7a8b-de4d-4707-924b-d283f273fe2c","stageNameKey":"New","stageName":"New","stageBadgeColor":"New"},"attributeValues":{"attributeSingleSelectValue.value21":[{"id":"c5c3167e-f8e2-4719-a0a1-491350507fee","value":"Azure Documentation","valueKey":"OneTrustApp.VRM.Engagement.Attributes.e38d9fe7-a5b7-43b0-b79f-ed7940669c99"}]},"viewOnly":false,"riskLevel":"MEDIUM","riskScore":2,"inherentRiskLevel":"MEDIUM","inherentRiskScore":2,"targetRiskLevel":"HIGH","targetRiskScore":2,"engagementStatus":"ACTIVE","lastUpdatedDate":"2023-05-10"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"
# --- truncated at 32 KB (103 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/onetrust/refs/heads/main/openapi/onetrust-third-party-management-third-party-risk-management-openapi.json