v1

latestOpenAPI 3.1.02026-07-14220425.8 KB
Submissions

List all submissions

The API endpoint provides the ability to retrieve a list of available submissions.

get/submissions

Query parameters

template_idinteger

The template ID allows you to receive only the submissions created from that specific template.

status'pending' | 'completed' | 'declined' | 'expired'

Filter submissions by status.

qstring

Filter submissions based on submitter's name, email or phone partial match.

slugstring

Filter submissions by unique slug.

template_folderstring

Filter submissions by template folder name.

archivedboolean

Returns only archived submissions when true and only active submissions when false.

limitinteger

The number of submissions to return. Default value is 10. Maximum value is 100.

afterinteger

The unique identifier of the submission to start the list from. It allows you to receive only submissions with an ID greater than the specified value. Pass ID value from the pagination.next response to load the next batch of submissions.

beforeinteger

The unique identifier of the submission that marks the end of the list. It allows you to receive only submissions with an ID less than the specified value.

Response

OK

Example response

{
  "data": [
    {
      "name": "Test Submission Document"
    }
  ]
}