List web forms
Returns a list of web forms available to the authenticated user's profile, including each form's name, URL, authentication requirement, and enabled state.
Web form name
Web form name. Search for results that contain the specified characters in this parameter.
Sorting options
With parameters
Determines the detail level of the response body.
List of web forms retrieved successfully.
Unique identifier of the web form.
Date and time when the web form was last modified.
Display name of the web form.
Description of the web form.
URL where the web form is accessible.
Indicates whether the web form is active.
Indicates whether authentication is required to submit the web form.
Indicates whether the web form can be embedded in external pages.
Indicates whether the web form can be used as a standalone page.
Unique identifier of the web form.
Unique identifier of the user profile associated with the web form.
Unique identifier of the web form field.
Display order of the field within the form.
Display label of the field.
Input type of the field (e.g., text, select, checkbox).
Special processing type for the field, if applicable.
Placeholder text shown in the field before input.
Default value pre-populated in the field.
Available option values for select-type fields.
Indicates whether the field is required.
Indicates whether the field can be edited by the user.
Request blocked by WAF
curl -X GET \
"https://{instance}.kiteworks.com/rest/webForms" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
url = "https://{instance}.kiteworks.com/rest/webForms"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())Get a web form
Returns the details of the specified web form, including its name, URL, authentication requirement, enabled state, and associated fields. Accessible by both authenticated and unauthenticated users, subject to the form's access rules.
ID of the web form to be retrieved
With parameters
Determines the detail level of the response body.
Web form details retrieved successfully.
Unique identifier of the web form.
Date and time when the web form was last modified.
Display name of the web form.
Description of the web form.
URL where the web form is accessible.
Indicates whether the web form is active.
Indicates whether authentication is required to submit the web form.
Indicates whether the web form can be embedded in external pages.
Indicates whether the web form can be used as a standalone page.
Unique identifier of the web form.
Unique identifier of the user profile associated with the web form.
Unique identifier of the web form field.
Display order of the field within the form.
Display label of the field.
Input type of the field (e.g., text, select, checkbox).
Special processing type for the field, if applicable.
Placeholder text shown in the field before input.
Default value pre-populated in the field.
Available option values for select-type fields.
Indicates whether the field is required.
Indicates whether the field can be edited by the user.
Forbidden
Possible error codes: ERR_ACCESS_USER
Error code
Error message
Request blocked by WAF
curl -X GET \
"https://{instance}.kiteworks.com/rest/webForms/:id" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
id = "VALUE" # ID of the web form to be retrieved
url = f"https://{{instance}}.kiteworks.com/rest/webForms/{id}"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())