Provides access to the questionnaires that is part of a Hyperproof organization.
Questionnaires API (1.0)
- Mock serverhttps://developer.hyperproof.app/_mock/hyperproof-api/questionnaires/questionnaires.openapi
- Hyperproof UShttps://api.hyperproof.app/v1/questionnaires
- Hyperproof Govhttps://api.hyperproofgov.app/v1/questionnaires
- Hyperproof EUhttps://api.hyperproof.eu/v1/questionnaires
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://developer.hyperproof.app/_mock/hyperproof-api/questionnaires/questionnaires.openapi/?status=string' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'Success.
The method in which the questionnaire is accessed by the recipient
The type of object the questionnaire is associated with
Optional unique identifier of an object the questionnaire is directly associated too
The type of object created when a questionnaire is submitted (i.e. risk intake survey)
The unique identifier of the user who created the questionnaire
The date the questionnaire was created (ISO-8601 format)
The unique identifier of the user who last updated the questionnaire
The date the questionnaire was updated (ISO-8601 format)
[ { "id": "d88d505d-5199-11ee-a644-522476618ae8", "orgId": "ce83e3cd-5199-11ee-a644-522476618ae8", "name": "Vendor Questionnaire", "calculateRisk": true, "version": 0, "accessType": "invitation", "targetObjectType": "vendor", "targetObjectId": "", "status": "active", "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", "permissions": [] } ]
The type of the object.
The unique identifier of the questionnaire to send.
Information about who the questionnaire invitation is being sent to and for what vendor.
The unique identifier of the object to send the questionnaire to, e.g. vendor id.
The unique identifier of the owner of the object when respondentType is owner or ownerAndContact.
The unique identifiers of the contacts to send the questionnaire to when respondentType is contact or ownerAndContact.
- Mock serverhttps://developer.hyperproof.app/_mock/hyperproof-api/questionnaires/questionnaires.openapi/{questionnaireId}/send
- Hyperproof UShttps://api.hyperproof.app/v1/questionnaires/{questionnaireId}/send
- Hyperproof Govhttps://api.hyperproofgov.app/v1/questionnaires/{questionnaireId}/send
- Hyperproof EUhttps://api.hyperproof.eu/v1/questionnaires/{questionnaireId}/send
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://developer.hyperproof.app/_mock/hyperproof-api/questionnaires/questionnaires.openapi/{questionnaireId}/send' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"invitedToId": "42310868-81f9-48c3-b68a-6582495c36b7",
"objectInfo": [
{
"objectId": "859c5f4f-734d-4c7f-9673-efa7f30e4da8",
"ownerId": "75c7a61b-0366-48d4-843a-e9ff69292793",
"respondentType": "owner"
}
],
"objectType": "vendor",
"version": 0
}'Success.
The unique identifier for the questionnaire.
The unique identifier for the questionnaire invitation.
The completion status of the questionnaire.
The type of user the questionnaire was sent to (i.e. Owner or External Contact).
Collection of invitation recipients
The unique identifier of the user who created the questionnaire invitation.
The date the questionnaire invitation was created (ISO-8601 format).
The unique identifier of the user who last updated the questionnaire invitation.
The date the questionnaire invitation was updated (ISO-8601 format).
List of permissions the API user has on the question condition.
[ { "id": "5ba459d0-c69a-4ba3-b5d7-572c56838bfe", "orgId": "5bf47cef-6a4f-4ed1-aa8a-9a9cf6e2b831", "invitationId": "8a0c64fa-1bff-4741-a332-dc7458f7144a", "questionnaireId": "d297b753-05da-46bb-8558-15177350d244", "questionaireStatus": "sent", "invitationUserType": "owner", "version": 0, "latestResponseVersion": 0, "recipients": [ … ], "vendorName": "Acme", "status": "active", "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", "permissions": [] } ]
The unique identifiers of the questionnaires to filter the questionnaire invitations.
- Mock serverhttps://developer.hyperproof.app/_mock/hyperproof-api/questionnaires/questionnaires.openapi/invitations/filter
- Hyperproof UShttps://api.hyperproof.app/v1/questionnaires/invitations/filter
- Hyperproof Govhttps://api.hyperproofgov.app/v1/questionnaires/invitations/filter
- Hyperproof EUhttps://api.hyperproof.eu/v1/questionnaires/invitations/filter
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
https://developer.hyperproof.app/_mock/hyperproof-api/questionnaires/questionnaires.openapi/invitations/filter \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"questionnaireIds": [
"a3f96b88-51a8-4db0-9403-a40b8b6d92e4",
"cf09a1f6-3bcc-4e71-9c56-11bb83bf57d6"
],
"status": "active"
}'Success.
The unique identifier for the questionnaire.
The unique identifier for the questionnaire invitation.
The completion status of the questionnaire.
The type of user the questionnaire was sent to (i.e. Owner or External Contact).
Collection of invitation recipients
The unique identifier of the user who created the questionnaire invitation.
The date the questionnaire invitation was created (ISO-8601 format).
The unique identifier of the user who last updated the questionnaire invitation.
The date the questionnaire invitation was updated (ISO-8601 format).
List of permissions the API user has on the question condition.
[ { "id": "5ba459d0-c69a-4ba3-b5d7-572c56838bfe", "orgId": "5bf47cef-6a4f-4ed1-aa8a-9a9cf6e2b831", "invitationId": "8a0c64fa-1bff-4741-a332-dc7458f7144a", "questionnaireId": "d297b753-05da-46bb-8558-15177350d244", "questionaireStatus": "sent", "invitationUserType": "owner", "version": 0, "latestResponseVersion": 0, "recipients": [ … ], "vendorName": "Acme", "status": "active", "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", "permissions": [] } ]
- Mock serverhttps://developer.hyperproof.app/_mock/hyperproof-api/questionnaires/questionnaires.openapi/{questionnaireId}/invitations/{invitationId}/remind
- Hyperproof UShttps://api.hyperproof.app/v1/questionnaires/{questionnaireId}/invitations/{invitationId}/remind
- Hyperproof Govhttps://api.hyperproofgov.app/v1/questionnaires/{questionnaireId}/invitations/{invitationId}/remind
- Hyperproof EUhttps://api.hyperproof.eu/v1/questionnaires/{questionnaireId}/invitations/{invitationId}/remind
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://developer.hyperproof.app/_mock/hyperproof-api/questionnaires/questionnaires.openapi/{questionnaireId}/invitations/{invitationId}/remind' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'Success.
The unique identifier for the questionnaire.
The unique identifier for the questionnaire invitation.
The completion status of the questionnaire.
The type of user the questionnaire was sent to (i.e. Owner or External Contact).
Collection of invitation recipients
The unique identifier of the user who created the questionnaire invitation.
The date the questionnaire invitation was created (ISO-8601 format).
The unique identifier of the user who last updated the questionnaire invitation.
The date the questionnaire invitation was updated (ISO-8601 format).
{ "id": "5ba459d0-c69a-4ba3-b5d7-572c56838bfe", "orgId": "5bf47cef-6a4f-4ed1-aa8a-9a9cf6e2b831", "invitationId": "8a0c64fa-1bff-4741-a332-dc7458f7144a", "questionnaireId": "d297b753-05da-46bb-8558-15177350d244", "questionaireStatus": "sent", "invitationUserType": "owner", "version": 0, "latestResponseVersion": 0, "recipients": [ { … }, { … } ], "vendorName": "Acme", "status": "active", "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", "permissions": [] }
- Mock serverhttps://developer.hyperproof.app/_mock/hyperproof-api/questionnaires/questionnaires.openapi/{questionnaireId}
- Hyperproof UShttps://api.hyperproof.app/v1/questionnaires/{questionnaireId}
- Hyperproof Govhttps://api.hyperproofgov.app/v1/questionnaires/{questionnaireId}
- Hyperproof EUhttps://api.hyperproof.eu/v1/questionnaires/{questionnaireId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://developer.hyperproof.app/_mock/hyperproof-api/questionnaires/questionnaires.openapi/{questionnaireId}' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'Success.
The method in which the questionnaire is accessed by the recipient
The type of object the questionnaire is associated with
Optional unique identifier of an object the questionnaire is directly associated too
The type of object created when a questionnaire is submitted (i.e. risk intake survey)
The unique identifier of the user who created the questionnaire
The date the questionnaire was created (ISO-8601 format)
The unique identifier of the user who last updated the questionnaire
The date the questionnaire was updated (ISO-8601 format)
{ "id": "d88d505d-5199-11ee-a644-522476618ae8", "orgId": "ce83e3cd-5199-11ee-a644-522476618ae8", "name": "Vendor Questionnaire", "calculateRisk": true, "version": 0, "accessType": "invitation", "targetObjectType": "vendor", "targetObjectId": "", "status": "active", "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", "permissions": [] }
- Mock serverhttps://developer.hyperproof.app/_mock/hyperproof-api/questionnaires/questionnaires.openapi/{questionnaireId}/questions
- Hyperproof UShttps://api.hyperproof.app/v1/questionnaires/{questionnaireId}/questions
- Hyperproof Govhttps://api.hyperproofgov.app/v1/questionnaires/{questionnaireId}/questions
- Hyperproof EUhttps://api.hyperproof.eu/v1/questionnaires/{questionnaireId}/questions
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://developer.hyperproof.app/_mock/hyperproof-api/questionnaires/questionnaires.openapi/{questionnaireId}/questions?version=0' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'Success.
The unique identifier for the organization.
The list of options if the question is of type single select or multi-select.
The list of scores relative to the list of options. Relevant for the overall scoring of the questionnaire.
The unique identifier for the questionnaire the question belongs to.
The unique identifier for the questionnaire version the question belongs to.
The version number for the questionnaire version the question belongs to.
The name of the section in the questionnaire the question belongs to.
The type of question this is.
Represents a question number or other identifier. This value is unique within a questionnaire section.
The content of the question (i.e. what is being asked).
The weight of the question to relate the level of importance of a question in impacting the overall score of the questionnaire.
Indicates whether this question is managed by Hyperproof. This is typically only true for questionnaires that come pre-packaged by the system and related to questions needed to generate core object properties
An object and property mapping
The list of conditions used for displaying conditional questions.
The unique identifier of the user who created the question.
The date the question was created (ISO-8601 format).
The unique identifier of the user who last updated the question.
The date the question was updated (ISO-8601 format).
[ { "id": "0f5912e8-760e-11ef-8ae2-92105719a406", "orgId": "1dbe4d61-d8b2-11e9-9131-83d3f7zez54a", "questionnaireId": "0f580176-760e-11ef-8ae2-9210571za406", "questionnaireVersionId": "0f5876a7-760e-11ef-8ae2-9210z719a406", "questionnaireVersion": 0, "sectionName": "Vendors", "type": "textMultiSelect", "identifier": "Vendor Verification", "content": "Is this vendor verified?", "isRequired": "false,", "weight": 0, "ordering": 0, "isProofRequired": "false,", "sectionIdentifierKey": "vendor-verified", "questionOrder": 0, "options": [ … ], "scores": [ … ], "status": "active", "createdBy": "af5b547d-1f47-11ec-8eae-868cca974f0b", "updatedBy": "af5b547d-1f47-11ec-8eae-868cca974f0b", "createdOn": "2024-09-18T22:33:43.0893590+00:00", "updatedOn": "2024-09-18T22:33:43.0893590+00:00" } ]