Form Entries API
Each submitted form on a site is saved as a form entry.
Use the Form Entries API to return these entries.
Use the Form Entries API to return these entries.
Note: To authenticate with the Weebly API, you need to use OAuth. This will allow you to access resources based on a particular user and site.
In this topic:
Fields
The following table shows all the fields that exist for this API. The list view is returned when you retrieve a list. All fields are returned when you retrieve a single item.
Name |
Description |
Type |
List |
date_submitted |
Date the form entry was submitted |
Unix timestamp in GMT |
X |
ip_address |
The IP address of the machine submitting the form. |
string |
X |
form_entry_id |
The unique ID for a form entry. |
string |
X |
elements |
Each element object represents a field in the form and has 3 properties:
|
array of objects |
X |
Note: Any fields returned that are not documented are currently unsupported and can be safely ignored.
Retrieve a List of Form Entries for a Given Form
Endpoint URL
Returns all form entries for the given form.
Scope: read:site
Query Parameters
Parameter |
Description |
Type |
page |
Which page of results to return. Start is 1. Note: Only the first 25 results are returned by default. If the result set is expected to be over 25, you must implement pagination. |
integer |
limit |
Number of results per page to return. Default is 25. Max is 200. |
integer |
filterby |
Field name to set a filter on. |
string |
filterfor |
Value to search the filterby field for. |
string |
sortdir |
Sort direction. Valid values are:
Note: There is no sortby search parameter, as you can only sort by date_submitted. |
string |
Request
Example returning all entries:
Example of filtered request
Response
Response
Retrieve Details for a Form Entry
Enpoint URL
Returns the details of the given form entry.
Scope: read:site
Scope: read:site
Request
Example Request
Response
See Fields table. All fields for the form entry are returned.
Example Response