The list forms endpoint returns a JSON array of form objects. You must authenticate your request using one the accepted authentication methods.
By default, the endpoint will return the 10 most recently received forms.
GET https://api.nextform.app/forms
You can retrieve individual forms by including the form id.
GET https://api.nextform.app/forms/6bHJSMPCi2ieh7fWoLh6J3
You may filter the results using several available query parameters.
GET https://api.nextform.app/forms
?id=6bHJSMPCi2ieh7fWoLh6J3
&reference=ab0b12e2-979c-47be-97d8-acf614685d57
&name=Robert%20Smith
&email=user@example.com
&startDate=2021-03-01
&endDate=2021-03-31
&limit=3
&offset=0
Request a specific form id (same as including the id as a subdirectory, see example above).
If a reference string was set when the session was created, you may query it here.
If a brandId was set when the session was created, you may query it here. Brands are only available to users on the Enterprise Plan.
An individual's name. This parameter acts like a "text contains" search, meaning it will return all forms that match any part of the individual's name. This parameter only works for forms that contain an individual's name in the form data, such as form W-9 or form W-8BEN. Spaces can be included as URL-encoded values like %20.
A business name. This parameter acts like a "text contains" search, meaning it will return all forms that match any part of the business name. This parameter only works for forms that contain a business name in the form data, such as form W-9. Spaces can be included as URL-encoded values like %20.
A valid email address. Email addresses exist in the signature object rather than the form object, so when you list forms by email address, the endpoint returns all forms with an associated signature object that includes the email address.
A date formatted as YYYY-MM-DD. This will be interpreted as any date greater than or equal to the date provided.
A date formatted as YYYY-MM-DD. This will be interpreted as any date less than or equal to the date provided.
A number between 1 and 100. The default is 10. There is a maximum of 100 results per request.
The number of results to skip. For example, if you enter a limit of 100 and an offset of 100, the first 100 results will be skipped and the next 100 results will be returned. If you request a limit of 100 and you receive exactly 100 results, you may want to make a follow-up request with an offset of 100 to check for additional results. If there are no additional results the API will return an empty array.