API - Form - GET form/{id}

GET form/{id}

Used for

Retrieve the definition of a single form: the metadata, the parameters, the field order and the full field definitions (labels, types, validation parameters and per-language translations).

Authentication

User must be logged in at administrator level and have the api_form_get right. The form must belong to the authenticated license.

Parameters

Example

Request form 12.

GET api/rest/form/12

Response:
{
  "form_id": 12,
  "form_desc": "Contact",
  "title": "Contact us",
  "default": true,
  "params": {
    "login_required": false,
    "captcha_required": true,
    "process_form": "manual",
    "title": { "nl": "Neem contact op", "en": "Contact us" },
    "owner_id": 1234
  },
  "field_order": [ "name", "email", "message" ],
  "fields": {
    "name": {
      "field_name": "name",
      "field_display": "Name",
      "field_type": "2",
      "field_order": "1",
      "fd_type": "text",
      "fv_type": "text"
    },
    "email": {
      "field_name": "email",
      "field_display": "Email",
      "field_type": "2",
      "field_order": "2",
      "fd_type": "email",
      "fv_type": "email"
    },
    "message": {
      "field_name": "message",
      "field_display": "Message",
      "field_type": "1",
      "field_order": "3",
      "fd_type": "textarea",
      "fv_type": "text"
    }
  }
}