Get Forms

Description: To get a list of forms, a HTTP GET request is made to the URL. By default, the results of this end point are paged, refer to page paramater for additional information.

Method: GET

URI: /forms/

Parameters:

Page:
- Can be used to return additional pages of forms, an empty array will be returned when there are no more records.
- Default value is 1, if not passed
Query:
Can be used to filter forms by name based on passed query value.

Headers: Authorization: Third party based authorization header

Returns

Field	Type	Description
Form	Form Summary	A summary of the form object.

Example

Request

  curl https://app-api.reiformslive.com.au/forms/ \
  --request GET \
  --header "Authorization: Basic YTlkOWIwYItNGY4Yi1hYTQxLTI5NzZmMTcyZmEyMQ=="

Response

  [
    {
      "id": 1,
      "template_version_id": 1,
      "agency_id": 1,
      "user_id": 1,
      "name": "Important form",
      "template": false,
      "finalised": true,
      "private": false,
      "created": 1350966273,
      "updated": 1350966303,
      "given_name": "John",
      "surname": "Doe",
      "template_cost": 80,
      "template_id": 144,
      "template_name": "Agency Template",
      "template_code": "T1000",
      "template_instruction_pages": 1
    }, ...
  ]