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

Returns answers for forms user has completed

Request Information

URI Parameters

Name	Description	Type	Additional information
userId	Id for the member you want to retrieve form responses for	integer	Required
formId	Form Id to pull only responses for a particular form	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/members/{userId}/forms?formId={formId}&startDate={startDate}&endDate={endDate}&page={page}&pageSize={pageSize}

Response Information

Resource Description

MemberFormsResult

Name	Description	Type	Additional information
PageInfo		PageModel
Results		Collection of MemberFormResult

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,
      "FormName": "sample string 2",
      "DateCompleted": "2024-12-22T18:42:52.0100802Z",
      "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"
        }
      ]
    },
    {
      "FormId": 1,
      "FormName": "sample string 2",
      "DateCompleted": "2024-12-22T18:42:52.0100802Z",
      "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"
        }
      ]
    }
  ]
}

Back GET v1/members/{userId}/forms