Podio API Documentation
Forms: Get form
Returns the form with the given id.
Usage
- Ruby Gem
-
form.rb
Podio::Form.find( form_id )
Parameters
- form_id*
- Required.
Response
{
"form_id": The id of the form,
"app_id": The id of the app the form belongs to,
"space_id": The id of the space the form belongs to,
"status": Either "active" or "disabled",
"settings": The settings of the form,
{
"captcha": True if captcha is enabled, false otherwise,
"text": The texts used for the form,
{
"heading": A heading to display when the webform is not embedded (OPTIONAL),
"description": An explanatory text to display when the webform is not embedded (OPTIONAL),
"submit": The text for the submit button,
"success": The text when the form was successfully submitted
},
"color": The colors for the form in the form "#xxxxxx",
"theme": The theme to use, for a list of valid themes see the area
},
"domains": The list of domains where the form can be used,
[
"{domain}",
... (more domains)
],
"fields": The id and any form specific settings for each active field,
[
{
"field_id": The id of the field,
"settings": Any settings of the field which depends on the type of the field. See area for more information
}
... (more field ids)
],
"attachments": True if attachments are allowed, false otherwise
}
Sandbox
Try the operation "/form/{form_id}"You can simulate the API request by filling out the arguments below, and press the submit button to see the response.
You need to be logged in to Podio to use the Sandbox. Login here