GET v1/forms/{formId}/responses?userId={userId}&startDate={startDate}&endDate={endDate}&page={page}&pageSize={pageSize}

Returns answers for completed organization's forms

Request Information

URI Parameters

Name	Description	Type	Additional information
formId	Form Id to pull only responses for a particular form	integer	Required
userId	User Id to pull only responses for a particular user	integer
startDate	Only pull responses submitted on or after this date	date
endDate	Only pull responses submitted on or before this date	date
page	Page number (starting page is 1)	integer	Default value is 1
pageSize	Number of results to return (defaults to 25, max of 200)	integer	Default value is 25

Body Parameters

None.

Sample Request

https://api.servicereef.com/v1/forms/{formId}/responses?userId={userId}&startDate={startDate}&endDate={endDate}&page={page}&pageSize={pageSize}

Response Information

Resource Description

PagedListResultOfOrganizationFormResponseResult

Name	Description	Type	Additional information
PageInfo		PageModel
Results		Collection of OrganizationFormResponseResult

Try API

Try this endpoint by entering your credentials and using the API Explorer.

Try With API Explorer

Response Formats

application/json, text/json

Sample:

{
  "PageInfo": {
    "TotalRecords": 1,
    "Page": 2,
    "PageSize": 3
  },
  "Results": [
    {
      "FormId": 1,
      "FormResponseId": 2,
      "FormName": "sample string 3",
      "DateCompleted": "2024-12-22T18:57:53.9449317Z",
      "Answers": [
        {
          "QuestionId": 1,
          "Question": "sample string 2",
          "HelpText": "sample string 3",
          "Answer": "sample string 4",
          "QuestionType": "Unknown"
        },
        {
          "QuestionId": 1,
          "Question": "sample string 2",
          "HelpText": "sample string 3",
          "Answer": "sample string 4",
          "QuestionType": "Unknown"
        }
      ],
      "UserId": 1
    },
    {
      "FormId": 1,
      "FormResponseId": 2,
      "FormName": "sample string 3",
      "DateCompleted": "2024-12-22T18:57:53.9449317Z",
      "Answers": [
        {
          "QuestionId": 1,
          "Question": "sample string 2",
          "HelpText": "sample string 3",
          "Answer": "sample string 4",
          "QuestionType": "Unknown"
        },
        {
          "QuestionId": 1,
          "Question": "sample string 2",
          "HelpText": "sample string 3",
          "Answer": "sample string 4",
          "QuestionType": "Unknown"
        }
      ],
      "UserId": 1
    }
  ]
}

Back GET v1/forms/{formId}/responses