Get Single Form

Description: To get the details of a single form, a HTTP GET request is made to the URL with the form ID and session token.

Method: GET

URI:/forms/form_id

URI Parameters:

form_id: The ID of the form.

Parameters:

query: Can be used to retrieve forms with a certain name.

Headers: Authorization: Third party based authorization header

Returns

Field	Type	Description
Form	Form	A form object.

Example

Request

  curl https://app-api.reiformslive.com.au/forms/1 \
  --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": true,
    "created": 1351569329,
    "updated": 1351569546,
    "template_cost": 50,
    "template_instruction_pages": 0,
    "template_id": 131,
    "template_name": "Agency Template",
    "template_orientation": "portrait",
    "annexure_template_ids": [1, 2],
    "annexure_pdf_ids": [1],
    "values": {
      "Premises_Postcode": "5000",
      "Premises_Address": "123 Example Ave",
      "Parties_Principal_Title": "John Doe",
      "id": "1",
      "Agent_GST_Reg": "Yes",
      "Agent_Name": "Example Realty",
      "Agent_Licence_No": "000000",
      "Agent_ABN_ACN": "00 0000 0000",
      "Agent_Address": "1 Example St",
      "Agent_Address2": "",
      "Agent_Postcode": "5000",
      "Agent_Phone_Work": "08 0000 0000",
      "Agent_Phone_Mobile": "0000 000 000",
      "Agent_Fax": "",
      "Agent_Email": "agent@example.com",
      "Agent_Trading_As": "Example Realty Realty Ltd Pty"
    }
  }