Get submissions for a form

GET /form-integrations/v1/submissions/forms/:form_guid

Method Details

HTTP Methods:

GET

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

Marketing

Required Scope:

forms

Get the submissions for the specified form. This will include the fields in the submissions, the time of the form submission, and the page URL that the form was submitted on. Submissions will be returned in reverse-chronological order.

Note: This endpoint can only be used to get submissions for the following form types:
Required Parameters How to use Description
OAuth Access Token or API Key Authorization: Bearer {token} header or hapikey={key} query parameter. Used to authenticate the request. Please see this page for more details about authentication.
Form ID :form_guid
Used in the request URL
The unique guid for the form that you want to get the submissions from.

Optional Parameters How to use Description
Limit &limit= The number of results to include in the response. Defaults to 20, supports a maximum of 50.
After &after= Used to get the next page of results. Each response returns an after value, which is used with this parameter in the next request to get the next page of results.

Paging through results

Using the limit parameter, up to 50 submissions can be included in a single response. For forms with more than 50 submissions, you will need to page through the results using the after parameter.

Each response includes a paging field with details for getting the next page of results. When there are more results to page through, that paging field will include the next field, which will contain two fields: after and link. The after field would be used in the &after= parameter in the next request to get the next set of results. The link field will be the full query string used in the next request to get the next set of results, with the same limit parameter included. Note: When using an API key, the link field will not include the API key, so it would need to be added to the next request URL.

The paging field is only returned when there are more results, so if that field is absent in a response then you are at the end of the results.