Returns organization's forms

Request Information

URI Parameters

Name Description Type Additional information
hasResponses

Only pull forms with or without responses

boolean
startDate

Only pull forms created on or after this date

date
endDate

Only pull forms created 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?hasResponses={hasResponses}&startDate={startDate}&endDate={endDate}&page={page}&pageSize={pageSize}

Response Information

Resource Description

PagedListResultOfOrganizationFormResult
Name Description Type Additional information
PageInfo

PageModel
Results

Collection of OrganizationFormResult

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",
      "NumberOfResponses": 3,
      "Questions": [
        {
          "FormQuestionId": 1,
          "QuestionId": 2,
          "Name": "sample string 3",
          "QuestionType": "Unknown",
          "Status": "Draft"
        },
        {
          "FormQuestionId": 1,
          "QuestionId": 2,
          "Name": "sample string 3",
          "QuestionType": "Unknown",
          "Status": "Draft"
        }
      ]
    },
    {
      "FormId": 1,
      "FormName": "sample string 2",
      "NumberOfResponses": 3,
      "Questions": [
        {
          "FormQuestionId": 1,
          "QuestionId": 2,
          "Name": "sample string 3",
          "QuestionType": "Unknown",
          "Status": "Draft"
        },
        {
          "FormQuestionId": 1,
          "QuestionId": 2,
          "Name": "sample string 3",
          "QuestionType": "Unknown",
          "Status": "Draft"
        }
      ]
    }
  ]
}