GET/forms/{formId}/responses

Gets the response results of a form.
Only the creator or collaborator of the form can get the results.

Authorization

oauth2

OAuth 2.0 authentication.
For more information, see Authentication and Authorization.

Scope

form
form.read

HTTP Request

GEThttps://www.worksapis.com/v1.0/forms/{formId}/responses

Path Parameters

ParameterTypeDescription
formId string 

Form ID.

See How to get a formId.


required
example : 11e4316cb72f3373a4a0780ac6de6440 

Query Parameters

ParameterTypeDescription
cursor string 

Cursor value for pagination


example : JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA== 
count integer 

Number of items in a list


default : 500
minimum : 0
maximum : 1000
example : 300
format : int32 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
responses array (response) 
 
responseMetaData object (responseMetaData) 

Cursor metadata

 

response

PropertyTypeDescription
formId string 

Form ID

 
responseId string 

Response ID

 
respondedTime string 

Response time

 
respondent object (respondent) 

Respondent

 
questions array (question) 
 

respondent

PropertyTypeDescription
id string 

Respondent's user ID

 
name string 

Respondent name

 
email string 

Respondent email

 
organizationName string 

Respondent company name

 
orgUnitName string 

Respondent team name

 

question

PropertyTypeDescription
questionId string 

Question ID

 
questionType string 

Question type

  • SINGLE_CHOICE: Multiple choice (single answer)
  • MULTIPLE_CHOICE: Multiple choice (multiple answers)
  • TEXT: Open-ended
  • SINGLE_DATE: Schedule vote (single vote)
  • MULTIPLE_DATE: Schedule vote (multiple votes)
  • DROPDOWN: Drop down
  • RATING: Rating
  • DATE_INPUT: Enter a date
  • DATETIME_INPUT: Enter a date and time
  • ATTACHMENT: Attach an image

Allowed values : SINGLE_CHOICE, MULTIPLE_CHOICE, TEXT, SINGLE_DATE, MULTIPLE_DATE, DROPDOWN, RATING, DATE_INPUT, DATETIME_INPUT, ATTACHMENT 
title string 

Question title

 
description string 

Question description

 
required boolean 

Indicates whether a response is required.

 
answers array (string) 

Response data
See Form response results.

 

responseMetaData

PropertyTypeDescription
nextCursor string 

Cursor value for pagination

 

Response Example

Example 1

1{2  "responses": [3    {4      "formId": "7b19cbe30f1032a99f8a8621733aad70",5      "responseId": "d68d16bd6f453403a46256f64be2abdb",6      "respondedTime": "2024-08-28T17:01:44+09:00",7      "respondent": {8        "id": "725dc47e-fbee-404c-16ad-03ab80cee0c3",9        "name": "Penguin",10        "email": "penguin@wdomain6.com",11        "organizationName": "Penguin Stock Company",12        "orgUnitName": "Penguin Dev"13      },14      "questions": [15        {16          "questionId": "1f8775e0b52c",17          "questionType": "SINGLE_CHOICE",18          "title": "Question title",19          "description": "Question description",20          "required": true,21          "answers": [22            "Field1"23          ]24        }25      ]26    }27  ],28  "responseMetaData": {29    "nextCursor": "eyJjcmVhdGVkVGltZSI6MTY2NzM3MzQ0MCwib2Zmc2V0IjozLCJsaW1pdCI6M30"30  }31}

Example 2

1{2  "responses": [3    {4      "formId": "666576810dbe30dd927b8ef09d15a6a3",5      "responseId": "df5552c6581e329d8ba56f71212ef16b",6      "respondedTime": "2024-08-28T17:01:44+09:00",7      "questions": [8        {9          "questionId": "68629fb28e88",10          "title": "Question title",11          "questionType": "MULTIPLE_CHOICE",12          "description": "Question description",13          "required": true,14          "answers": [15            "Field1",16            "Field2"17          ]18        }19      ]20    }21  ],22  "responseMetaData": {23    "nextCursor": "eyJjcmVhdGVkVGltZSI6MTY2NzM3MzQ0MCwib2Zmc2V0IjozLCJsaW1pdCI6M30"24  }25}

Example 3

1{2  "responses": [3    {4      "formId": "666576810dbe30dd927b8ef09d15a6a3",5      "responseId": "df5552c6581e329d8ba56f71212ef16b",6      "respondedTime": "2024-08-28T17:01:44+09:00",7      "questions": [8        {9          "questionId": "68629fb28e88",10          "questionType": "ATTACHMENT",11          "title": "Question title",12          "description": "Question description",13          "required": true,14          "answers": [15            "1122706"16          ]17        }18      ]19    }20  ],21  "responseMetaData": {22    "nextCursor": "eyJjcmVhdGVkVGltZSI6MTY2NzM3MzQ0MCwib2Zmc2V0IjozLCJsaW1pdCI6M30"23  }24}