v3
latestSwagger 2.02026-08-067506752.0 MBassessment
Return an overview of the forms and questions used in the assessment. If the user has read access to the assessment, then the forms and questions are visible, even if they would not otherwise be visible on their own
get/v1/org/{orgId}/assessment/{assessmentId}/forms-questions
Path parameters
orgIdstring required
Org identifier (either id or slug)
assessmentIdstring required
Assessment id
Response
successful operation
Example response
{
"forms": [
{
"id": "588f7ee98f138b19220041a7",
"orgId": "588f7ee98f138b19220041a7",
"label": "Health Index: Q2",
"displayName": "Health Index",
"description": "The Engineering department, where engineers develop new technology and products.",
"blocks": [
{
"id": "588f7ee98f138b19220041a7",
"questionId": "588f7ee98f138b19220041a7"
}
],
"signature": {
"fieldId": "588f7ee98f138b19220041a7"
},
"options": {
"notifyUserIds": [
"588f7ee98f138b19220041a7"
]
},
"ai": {
"agentUserId": "588f7ee98f138b19220041a7"
},
"createId": "588f7ee98f138b19220041a7",
"createBehalfId": "588f7ee98f138b19220041a7",
"createAttribution": {
"principalUserId": "588f7ee98f138b19220041a7",
"agentUserIds": [
"588f7ee98f138b19220041a7"
],
"eventId": "588f7ee98f138b19220041a7",
"aiChatId": "588f7ee98f138b19220041a7"
},
"createAt": "2017-01-24T13:52Z",
"updateId": "588f7ee98f138b19220041a7",
"updateBehalfId": "588f7ee98f138b19220041a7",
"updateAttribution": {
"principalUserId": "588f7ee98f138b19220041a7",
"agentUserIds": [
"588f7ee98f138b19220041a7"
],
"eventId": "588f7ee98f138b19220041a7",
"aiChatId": "588f7ee98f138b19220041a7"
},
"updateAt": "2017-01-24T13:57:52Z",
"deleteId": "588f7ee98f138b19220041a7",
"deleteBehalfId": "588f7ee98f138b19220041a7",
"deleteAttribution": {
"principalUserId": "588f7ee98f138b19220041a7",
"agentUserIds": [
"588f7ee98f138b19220041a7"
],
"eventId": "588f7ee98f138b19220041a7",
"aiChatId": "588f7ee98f138b19220041a7"
},
"deleteAt": "2017-01-24T13:57:52Z"
}
],
"questions": [
{
"id": "588f7ee98f138b19220041a7",
"orgId": "588f7ee98f138b19220041a7",
"question": "What is your favorite color?",
"fieldId": "588f7ee98f138b19220041a7",
"values": [
{
"id": "588f7ee98f138b19220041a7"
}
],
"createId": "588f7ee98f138b19220041a7",
"createBehalfId": "588f7ee98f138b19220041a7",
"createAttribution": {
"principalUserId": "588f7ee98f138b19220041a7",
"agentUserIds": [
"588f7ee98f138b19220041a7"
],
"eventId": "588f7ee98f138b19220041a7",
"aiChatId": "588f7ee98f138b19220041a7"
},
"createAt": "2017-01-24T13:57:52Z",
"updateId": "588f7ee98f138b19220041a7",
"updateBehalfId": "588f7ee98f138b19220041a7",
"updateAttribution": {
"principalUserId": "588f7ee98f138b19220041a7",
"agentUserIds": [
"588f7ee98f138b19220041a7"
],
"eventId": "588f7ee98f138b19220041a7",
"aiChatId": "588f7ee98f138b19220041a7"
},
"updateAt": "2017-01-24T13:57:52Z",
"deleteId": "588f7ee98f138b19220041a7",
"deleteBehalfId": "588f7ee98f138b19220041a7",
"deleteAttribution": {
"principalUserId": "588f7ee98f138b19220041a7",
"agentUserIds": [
"588f7ee98f138b19220041a7"
],
"eventId": "588f7ee98f138b19220041a7",
"aiChatId": "588f7ee98f138b19220041a7"
},
"deleteAt": "2017-01-24T13:57:52Z"
}
]
}