Gravity Forms icon

Gravity Forms

Interact with Gravity Forms REST API v2

Actions10

Overview

This node integrates with the Gravity Forms REST API v2, specifically enabling interaction with forms and their entries. The Form - List operation fetches multiple forms from a Gravity Forms installation. It supports retrieving all forms or limiting the number of returned forms, with options to filter by active status or whether the form is in the trash.

Typical use cases include:

  • Synchronizing available forms from Gravity Forms into another system.
  • Displaying a list of forms for selection in an automation workflow.
  • Filtering forms based on their active state or trash status for reporting or cleanup tasks.

For example, you might use this node to retrieve all active forms to generate a report or to limit the results to 50 forms for quick display in a dashboard.

Properties

Name Meaning
Return All Whether to return all forms (true) or limit the number of forms returned (false).
Limit Maximum number of forms to return when "Return All" is false. Range: 1 to 500.
Additional Fields Optional filters:
• Active Only — Return only active forms (boolean).
• Trash — Include only forms in trash (boolean).

Output

The output is an array of JSON objects, each representing a form retrieved from Gravity Forms. Each form object contains all the properties as returned by the Gravity Forms API, such as form ID, title, fields, and other metadata.

Example output structure (simplified):

[
  {
    "id": 1,
    "title": "Contact Form",
    "fields": [
      {
        "id": 3,
        "label": "Name",
        "type": "text",
        "isRequired": true
      }
    ],
    "is_active": true,
    ...
  },
  ...
]

No binary data is output by this operation.

Dependencies

  • Requires a configured API authentication credential for Gravity Forms REST API v2.
  • The node uses HTTP requests to communicate with the Gravity Forms API endpoints.
  • Proper permissions and API access must be granted in the Gravity Forms installation.

Troubleshooting

  • Empty or invalid JSON input error: If providing JSON input for other operations, ensure it is valid JSON. For the List operation, this is not applicable.
  • API request failures: Common causes include incorrect API credentials, insufficient permissions, or network issues. Verify the API key/token and endpoint URL.
  • Unsupported operation errors: Ensure that the selected resource is "form" and operation is "getAll" (List). Other operations require different parameters.
  • Limit out of range: The limit property must be between 1 and 500; values outside this range may cause errors.
  • Filtering conflicts: Using both "Active Only" and "Trash" filters simultaneously may result in no forms being returned if no forms match both criteria.

Links and References

Discussion