Submissions

Programmatically query and filter your form submission data.

Submission API Actions


ActionMethodPath
ListGET/api/v1/submissions
ShowGET/api/v1/submissions/{:id}
DeleteDELETE/api/v1/submissions/{:id}

List Submissions


You can return a list of submission data using various filtering options that are similar to the functionality available in the app's submission dashboard for each form. The submissions returned sorted by creation date, with the most recent submissions appearing first.

ArgumentOptions
form_id (required)The form ID is required along with the API token for security reasons.
filter_by (string, optional)options: [All, New, Spam, Trash], default: all, all: new + read messages combined
query (string, optional)Search your submissions for specific content
Example API call
HTTPS
https://usebasin.com/api/v1/submissions?filter_by=All&form_id={form_id}&page=1&query=&api_token={form_api_token}

Make sure you swap out  {form_id}  with your unique form ID, otherwise we won't know which form to pull the data from.

Show Submission


You can view the details of a specific submission by passing the Submission's ID to the API endpoint.

Example API call
HTTPS
https://usebasin.com/api/v1/submissions/{id}?api_token={form_api_token}

Delete Submission


You can delete a specific submission by passing the Submission's ID to the API endpoint.

Example API call
HTTPS
curl -X DELETE "https://usebasin.com/api/v1/submissions/{id}?api_token={form_api_token}"