Get Form | propelone | Documentation

curl https://https//https/forms/%7Bform_id%7D \
     -H "{{tenant_key_name}}: {{tenant_key_value1}}|{{tenant_key_value2}}" \
     -H "Content-Type: application/json"

{
  "formId": "a1b2c3d4-e5f6-7890-ab12-cd34ef56gh78",
  "name": "Employee Onboarding Form",
  "description": "Form template for new employee onboarding process",
  "createdAt": "2024-05-10T09:15:00Z",
  "updatedAt": "2024-06-01T12:00:00Z",
  "sections": [
    {
      "sectionId": "sec-001",
      "title": "Personal Information",
      "description": "Collect basic personal details",
      "fields": [
        {
          "fieldId": "fld-001",
          "label": "First Name",
          "type": "text",
          "required": true,
          "placeholder": "Enter first name"
        },
        {
          "fieldId": "fld-002",
          "label": "Last Name",
          "type": "text",
          "required": true,
          "placeholder": "Enter last name"
        },
        {
          "fieldId": "fld-003",
          "label": "Date of Birth",
          "type": "date",
          "required": true
        }
      ]
    },
    {
      "sectionId": "sec-002",
      "title": "Job Details",
      "description": "Information about the new hire's job",
      "fields": [
        {
          "fieldId": "fld-004",
          "label": "Job Title",
          "type": "dropdown",
          "required": true,
          "options": [
            "Software Engineer",
            "Product Manager",
            "HR Specialist",
            "Sales Associate"
          ]
        },
        {
          "fieldId": "fld-005",
          "label": "Start Date",
          "type": "date",
          "required": true
        }
      ]
    }
  ],
  "conditionalRules": [
    {
      "ruleId": "rule-001",
      "condition": "Job Title == 'Software Engineer'",
      "actions": [
        {
          "actionType": "showField",
          "fieldId": "fld-006"
        }
      ]
    }
  ],
  "triggers": [
    {
      "triggerId": "trg-001",
      "event": "formSubmitted",
      "actions": [
        {
          "actionType": "sendNotification",
          "recipient": "hr@company.com",
          "message": "New employee onboarding form submitted"
        }
      ]
    }
  ],
  "alerts": [
    {
      "alertId": "alert-001",
      "message": "Please complete all required fields before submitting.",
      "type": "warning"
    }
  ],
  "businessUnits": [
    {
      "unitId": "bu-001",
      "name": "Human Resources"
    }
  ]
}

Retrieve full details of a single form template including sections, fields, conditional rules, triggers, alerts, and business units.

Response

Successful response

1	{
2	"formId": "a1b2c3d4-e5f6-7890-ab12-cd34ef56gh78",
3	"name": "Employee Onboarding Form",
4	"description": "Form template for new employee onboarding process",
5	"createdAt": "2024-05-10T09:15:00Z",
6	"updatedAt": "2024-06-01T12:00:00Z",
7	"sections": [
8	{
9	"sectionId": "sec-001",
10	"title": "Personal Information",
11	"description": "Collect basic personal details",
12	"fields": [
13	{
14	"fieldId": "fld-001",
15	"label": "First Name",
16	"type": "text",
17	"required": true,
18	"placeholder": "Enter first name"
19	},
20	{
21	"fieldId": "fld-002",
22	"label": "Last Name",
23	"type": "text",
24	"required": true,
25	"placeholder": "Enter last name"
26	},
27	{
28	"fieldId": "fld-003",
29	"label": "Date of Birth",
30	"type": "date",
31	"required": true
32	}
33	]
34	},
35	{
36	"sectionId": "sec-002",
37	"title": "Job Details",
38	"description": "Information about the new hire's job",
39	"fields": [
40	{
41	"fieldId": "fld-004",
42	"label": "Job Title",
43	"type": "dropdown",
44	"required": true,
45	"options": [
46	"Software Engineer",
47	"Product Manager",
48	"HR Specialist",
49	"Sales Associate"
50	]
51	},
52	{
53	"fieldId": "fld-005",
54	"label": "Start Date",
55	"type": "date",
56	"required": true
57	}
58	]
59	}
60	],
61	"conditionalRules": [
62	{
63	"ruleId": "rule-001",
64	"condition": "Job Title == 'Software Engineer'",
65	"actions": [
66	{
67	"actionType": "showField",
68	"fieldId": "fld-006"
69	}
70	]
71	}
72	],
73	"triggers": [
74	{
75	"triggerId": "trg-001",
76	"event": "formSubmitted",
77	"actions": [
78	{
79	"actionType": "sendNotification",
80	"recipient": "hr@company.com",
81	"message": "New employee onboarding form submitted"
82	}
83	]
84	}
85	],
86	"alerts": [
87	{
88	"alertId": "alert-001",
89	"message": "Please complete all required fields before submitting.",
90	"type": "warning"
91	}
92	],
93	"businessUnits": [
94	{
95	"unitId": "bu-001",
96	"name": "Human Resources"
97	}
98	]
99	}

Headers

Response