v1

latestOpenAPI 3.0.22026-07-146168117.0 KB
Submissions

This endpoint returns a list of submissions for a form matching the requested parameters. This feature is available as part of the Standard API.

get/forms/{slug_or_id}/submissions

Path parameters

slug_or_idstring required

The form's slug, custom slug or ID.

Query parameters

limitinteger

The number or results to return.

skipinteger

Number of results to skip in the result set.

after_idstring

Return results after the provided ID.

before_idstring

Return results before the provided ID.

before_datestring date-time

Return results created on or after this date-time (UTC). Overwritten by before_id.

after_datestring date-time

Return results created before this date (UTC). Overwritten by after_id.

sort'ASC' | 'DESC'

The direction to sort in. Results are sorted by created_at, and defaults to "DESC".

Response

Successfully returned a list of submissions

status'ok'
totalinteger

The total number of items.

has_moreboolean

Whether there are more items.

limitinteger

The limit of items per page.

skipinteger

The number of items to skip.

Example response

{
  "results": {
    "submissions": [
      {
        "id": "5d40fdaf174b4c0007043072",
        "form_id": "5d40fdaf174b4c0007043072",
        "created_at": "2019-04-14T09:00:00.000Z",
        "account_timezone": "America/Los_Angeles",
        "created_at_utc": "2019-04-14T09:00:00.000Z"
      }
    ]
  },
  "total": 57,
  "has_more": true,
  "limit": 20
}