![Hyperproof.Io [Test] Help Center](https://downloads.intercomcdn.com/i/o/xgk1dxp2/757668/427b255f2659cc7e0853d6a00ec1/628914ae2617199b7d999ba797a5305a.png)
The Hyperproof APIs allow developers to read and write Hyperproof data. This gives anyone the ability to automate and embed functionality into their own application. Hyperproof APIs include:
Controls API
The Controls API provides access to the controls in your organization using the following API endpoints:
POST https://api.hyperproof.app/v1/controls/ - Adds a new control to an organization.
POST https://api.hyperproof.app/v1/controls/{controlId}/proof - Adds a piece of proof to a control.
GET https://api.hyperproof.app/v1/controls/{controlId} - Returns a control by control ID.
GET https://api.hyperproof.app/v1/controls/summaries[?canLink][&status] - Returns control summaries for an organization.
GET https://api.hyperproof.app/v1/controls/[?canLink][&expandScopes][&expandTeams][&status] - Returns controls for an organization.
PUT https://api.hyperproof.app/v1/controls/filter - Returns a set of controls matching the filter you supply.
PATCH https://api.hyperproof.app/v1/controls/{controlId} - Updates an existing control with new values.
Custom apps API
The Custom apps API provides access to apps installed in your organization using the following API endpoints:
POST https://api.hyperproof.app/v1/customapps/ - Adds a new custom app to your organization.
DEL https://api.hyperproof.app/v1/customapps/{appId} - Deletes a custom app from your organization.
GET https://api.hyperproof.app/v1/customapps/{appId}/stats - Returns the statistics for a custom app installed in your organization.
GET https://api.hyperproof.app/v1/customapps/{appId} - Returns a custom app installed in your organization.
GET https://api.hyperproof.app/v1/customapps/{appId}/events - Returns log events generated by a custom app.
GET https://api.hyperproof.app/v1/customapps/ - Returns the custom apps installed in your organization.
PATCH https://api.hyperproof.app/v1/customapps/{appId} - Updates a custom app that is installed in your organization.
Custom fields API
The Custom fields API provides access to the custom fields in your organization using the following API endpoints:
GET https://api.hyperproof.app/v1/customfields/[?objectType] - Returns all custom fields for your organization.
External contacts API
The External contacts API provides access to the contacts in your organization using the following API endpoints:
POST https://api.hyperproof.app/v1/externalcontacts/ - Adds a new external contact to a supported Hyperproof object in your organization.
DEL https://api.hyperproof.app/v1/externalcontacts/{externalContactId} - Deletes an external contact from your organization.
GET https://api.hyperproof.app/v1/externalcontacts/{externalContactId} - Returns an external contact in your organization by ID.
GET https://api.hyperproof.app/v1/externalcontacts/[?objectType][&objectId] - Returns external contacts in your organization.
PATCH https://api.hyperproof.app/v1/externalcontacts/{externalContactId} - Updates an existing external contact in your organization with new values.
Groups API
The Groups API provides access to the groups of users in your organization using the following API endpoints:
POST https://api.hyperproof.app/v1/groups/ - Adds a new group to your organization.
POST https://api.hyperproof.app/v1/groups/{groupId}/users - Adds a user to a group in your organization.
GET https://api.hyperproof.app/v1/groups/{groupId} - Returns a group in your organization by ID.
GET https://api.hyperproof.app/v1/groups/{groupId}/users - Returns the members of a group in your organization.
GET https://api.hyperproof.app/v1/groups/users[?status] - Returns the members of a group in your organization filtered by the selected status of archived or active.
GET https://api.hyperproof.app/v1/groups/[?status][&expand] - Returns the groups in your organization.
PUT https://api.hyperproof.app/v1/groups/{groupId}/users/delete - Removes members from a group.
PATCH https://api.hyperproof.app/v1/groups/{groupId} - Updates an existing group with new values.
Issues API
The Issues API provides access to the Issues in your organization using the following API endpoints:
POST https://api.hyperproof.app/v1/issues/ - Adds a new issue to your organization.
POST https://api.hyperproof.app/v1/issues/{issueId}/comments - Adds a comment to an issue's activity feed.
POST https://api.hyperproof.app/v1/issues/{issueId}/proof - Adds a piece of proof to an issue.
DEL https://api.hyperproof.app/v1/issues/{issueId}/comments/{commentId} - Deletes a comment from an issue's activity feed.
GET https://api.hyperproof.app/v1/issues/{issueId} - Returns an issue in your organization by the issue ID.
GET https://api.hyperproof.app/v1/issues/{issueId}/comments - Returns the comments in an issue's activity feed.
GET https://api.hyperproof.app/v1/issues/{issueId}/proof - Returns the proof metadata for proof linked to an issue.
PUT https://api.hyperproof.app/v1/issues/filter - Returns a filtered list of issues.
PATCH https://api.hyperproof.app/v1/issues/{issueId} - Updates an existing issue with new values based on the issue ID.
PATCH https://api.hyperproof.app/v1/issues/{issueId}/comments/{commentId} - Updates an existing comment in an issue's activity feed based on the issue and the comment IDs.
Labels API
The Labels API provides access to the labels in your organization using the following API endpoints:
POST https://api.hyperproof.app/v1/labels/ - Adds a new label to your organization.
POST https://api.hyperproof.app/v1/labels/{labelId}/proof - Adds a piece of proof to a label.
GET https://api.hyperproof.app/v1/labels/{labelId} - Returns a label based on the label ID.
GET https://api.hyperproof.app/v1/labels/summaries[?canLink][&status] - Returns label summaries.
GET https://api.hyperproof.app/v1/labels/[?canLink][&status] - Returns labels for your organization.
PATCH https://api.hyperproof.app/v1/labels/{labelId} - Updates an existing label with new values based on the label ID.
Policies API
The Policies API provides access to the policies in your organization using the following API endpoints:
GET https://api.hyperproof.app/v1/policies - Returns the policies in your organization.
GET https://api.hyperproof.app/v1/policies/{policyId} - Returns a policy based on the policy ID.
POST https://api.hyperproof.app/v1/policies - Adds a new policy to your organization.
PATCH https://api.hyperproof.app/v1/policies/{policyId} - Updates a single policy with new values.
PATCH https://api.hyperproof.app/v1/policies - Updates existing policies with new values in bulk.
Policy versions API
The Policy verisions API provides access to individual versions of a policy in your organization using the following API endpoints:
GET https://api.hyperproof.app/v1/policyversions?policyId={policyId} - Returns the policy versions associated with a specific policy.
GET https://api.hyperproof.app/v1/policyversions/{versionId} - Returns a policy version by ID.
POST https://api.hyperproof.app/v1/policyversions?policyId={policyId} - Adds a new policy version to a specific policy.
PATCH https://api.hyperproof.app/v1/policyversions/{versionId}?policyId={policyId} - Updates a single policy version with new values.
Programs API
The Programs API provides access to the programs in your organization using the following API endpoints:
POST https://api.hyperproof.app/v1/programs/ - Adds a new program to your organization.
GET https://api.hyperproof.app/v1/programs/{programId} - Returns an existing program by program ID.
GET https://api.hyperproof.app/v1/programs/[?status] - Returns existing programs filtered by status.
PATCH https://api.hyperproof.app/v1/programs/{programId} - Updates a program based on program ID.
Proof API
The Proof API provides access to the pieces of proof in your organization using the following API endpoints:
POST https://api.hyperproof.app/v1/proof/ - Adds a new piece of proof to your organization.
POST https://api.hyperproof.app/v1/proof/{proofId}/versions - Adds a new version of an existing piece of proof.
GET https://api.hyperproof.app/v1/proof/{proofId} - Returns metadata for a piece of proof by proof ID.
GET https://api.hyperproof.app/v1/proof/[?limit][&sortBy][&sortDirection][&nextToken][&objectType][&objectId] - Returns proof metadata for an organization, control, label, or task.
GET https://api.hyperproof.app/v1/proof/{proofId}/contents[?version] - Returns the file contents of a piece of proof.
Questionnaires API
The Questionnaires API provides access to the vendor questionnaires in your organization using the following API endpoints:
GET https://api.hyperproof.app/v1/questionnaires/{questionnaireId} - Returns a questionnaire by questionnaire ID.
PUT https://api.hyperproof.app/v1/questionnaires/invitations/filter - Returns a set of questionnaire invitations based on the filter you provide.
GET https://api.hyperproof.app/v1/questionnaires/{questionnaireId}/questions[?version] - Returns all questions from the latest version of a questionnaire based on the questionnaire ID.
GET https://api.hyperproof.app/v1/questionnaires/[?status] - Returns all questionnaires for your organization.
PUT https://api.hyperproof.app/v1/questionnaires/{questionnaireId}/send - Sends a new questionnaire to a collection of recipients.
PUT https://api.hyperproof.app/v1/questionnaires/{questionnaireId}/invitations/{invitationId}/remind - Sends a questionnaire reminder to a specific recipient based on the invitation ID of the original invitation to complete the questionnaire.
Risks API
TheRisks API provides access to the risks in your organization using the following API endpoints:
POST https://api.hyperproof.app/v1/risks/ - Adds a new risk to your organization.
GET https://api.hyperproof.app/v1/risks/{riskId}[?expand] - Returns a specific risk by risk ID.
GET https://api.hyperproof.app/v1/risks/[?riskRegisterId][&status][&expand][&expand] - Returns risks for your organization. By default, Hyperproof returns only active risks.
PUT https://api.hyperproof.app/v1/risks/filter[?expand] - Returns a filtered list of risks.
PATCH https://api.hyperproof.app/v1/risks/{riskId} - Updates an existing risk with new values.
Roles API
The Roles API provides access to Hyperproof roles using the following API endpoints:
GET https://api.hyperproof.app/v1/roles/ - Returns a list of Hyperproof roles.
Scope assignments API
The Scope assignments API provides access to the hierarchical scopes in your organization using the following API endpoints:
POST https://api.hyperproof.app/v1/scopeassignments/scopeassignments - Creates or updates hierarchical scope assignments in a Hyperproof organization.
Scopes API
The Scopes API provides access to the scopes in your organization using the following API endpoints:
PATCH https://api.hyperproof.app/v1/scopes/ - Updates one or more existing scopes with new values.
POST https://api.hyperproof.app/v1/scopes/ - Adds a new scope to an organization.
POST https://api.hyperproof.app/v1/scopes/filter - Returns the set of scopes matching the supplied filter.
GET https://api.hyperproof.app/v1/scopes/{scopeId}- Returns the specified scope for the specified organization.
POST https://api.hyperproof.app/v1/scopes/tree - Returns the scope tree for the organization.
GET https://api.hyperproof.app/v1/scopes/ - Returns the scopes for the organization.
PATCH https://api.hyperproof.app/v1/scopes/{scopeId} - Updates an existing scope with new values.
Task statuses API
The Task statuses API provides access to the task statuses in your organization using the following API endpoints:
GET https://api.hyperproof.app/v1/taskstatuses/ - Returns a list of task statuses in your organization.
Tasks API
The Tasks API provides access to the tasks in your organization using the following API endpoints:
POST https://api.hyperproof.app/v1/tasks/ - Adds a new task to your organization.
POST https://api.hyperproof.app/v1/tasks/{taskId}/comments - Adds a comment to a task's Activity Feed.
POST https://api.hyperproof.app/v1/tasks/{taskId}/proof - Adds a piece of proof to a task.
DEL https://api.hyperproof.app/v1/tasks/{taskId}/comments/{commentId} - Deletes an existing comment from a task's Activity Feed.
GET https://api.hyperproof.app/v1/tasks/{taskId} - Returns a task by task ID.
GET https://api.hyperproof.app/v1/tasks/{taskId}/comments - Returns the comments in a specific task's Activity Feed.
GET https://api.hyperproof.app/v1/tasks/{taskId}/proof - Returns the proof metadata for proof linked to a specific task.
PUT https://api.hyperproof.app/v1/tasks/filter - Returns a set of tasks that match the selected filter.
PATCH https://api.hyperproof.app/v1/tasks/{taskId} - Updates an existing task with new values.
PATCH https://api.hyperproof.app/v1/tasks/{taskId}/comments?sourceCommentId={sourceCommentId} - Updates an existing comment in a task's Activity Feed based on the ID of the source comment.
PATCH https://api.hyperproof.app/v1/tasks/{taskId}/comments/{commentId} - Updates an existing comment in a task's Activity Feed.
Test results API
The Test results API provides access to the results of your Automated Control Tests on proof using the following endpoints:
GET https://api.hyperproof.app/v1/testresults/mostrecent?outcome={outcome}[&testParentObjectType][&limit][&nextToken] - Returns full details on the most recent test results matching the provided filters.
Users API
The Users API provides access to the users in your organization using the following API endpoints:
GET https://api.hyperproof.app/v1/users/me[?expand] - Returns the user information for the user making the API request.
GET https://api.hyperproof.app/v1/users/[?expand][&includeDeactivated] - Returns the users in your organization.
Vendors API
The Vendors API provides access to the vendors in your organization using the following API endpoints:
POST https://api.hyperproof.app/v1/vendors/ - Adds a new vendor to your organization.
GET https://api.hyperproof.app/v1/vendors/{vendorId} - Returns a vendor by vendor ID.
GET https://api.hyperproof.app/v1/vendors/[?status] - Returns the vendors for your organization.
PUT https://api.hyperproof.app/v1/vendors/filter - Returns a filtered list of vendors.
PATCH https://api.hyperproof.app/v1/vendors/{vendorId} - Updates an existing vendor with new values.
PATCH https://api.hyperproof.app/v1/vendors/ - Updates multiple vendors with new values.