Get the Definition of the Form

Required permissions: Any

get

Path parameters

formIDstring · uuidRequired

Query parameters

apiTokenstringRequired

API authentication token

Responses

200

OK

application/json

layoutIDstringOptional

introstringOptional

outrostringOptional

inactivestringOptional

formIDstringOptional

namestringOptional

createDatestring · date-timeOptional

lastModifiedDatestring · date-timeOptional

statusstringOptional

descriptionstringOptional

modestringOptional

401

Incorrect Permissions or Invalid API Token

application/json

500

Engage Server Error. Unable to process response at this time.

application/json

get/forms/{formID}

GET /forms/{formID}?apiToken=text HTTP/1.1
Host: api.ubiquity.co.nz
Accept: */*

{
  "fields": [
    {
      "id": "text",
      "displayOrder": 1,
      "isVisible": true,
      "itemType": "text"
    }
  ],
  "transactionalForms": [
    {
      "transactionalFormID": "text",
      "minTransactions": 1,
      "maxTransactions": 1,
      "addButtonText": "text",
      "deleteButtonText": "text",
      "fields": [
        {
          "id": "text",
          "displayOrder": 1,
          "isVisible": true,
          "itemType": "text"
        }
      ]
    }
  ],
  "layoutID": "text",
  "intro": "text",
  "outro": "text",
  "inactive": "text",
  "formID": "text",
  "name": "text",
  "createDate": "2026-01-01T00:00:00.000Z",
  "lastModifiedDate": "2026-01-01T00:00:00.000Z",
  "status": "text",
  "description": "text",
  "mode": "text"
}