Sign in

v1

OpenAPI 3.0.02026-08-04109109370.6 KB
Forms

Get a form

Get a single form by the ID provided. The fields used in the form are also returned in the response.

get/forms/{id}

Path parameters

idstring required

Form ID

Response

Form

linksobject

Example response

{
  "meta": {
    "instanceId": "12345"
  },
  "wfForms": [
    {
      "id": "3-contacts",
      "name": "Client Questionnaire",
      "links": {
        "fields": [
          "1-wfFields"
        ]
      }
    }
  ],
  "wfFields": [
    {
      "id": "3-contacts",
      "label": "Full Name",
      "fieldName": "name",
      "fieldType": "textfield",
      "entityName": "Contacts"
    }
  ]
}