GET
/
submissions
curl --request GET \
  --url https://app.formbox.app/api/v1/submissions \
  --header 'api-key: <api-key>'
{
  "data": [
    {
      "id": "<string>",
      "formId": "<string>",
      "isSpam": true,
      "answers": [
        {
          "id": "<string>",
          "label": "<string>",
          "value": "<string>"
        }
      ],
      "files": [
        {
          "id": "<string>",
          "name": "<string>",
          "type": "<string>",
          "size": 123,
          "url": "<string>",
          "createdAt": "<string>",
          "updatedAt": "<string>"
        }
      ],
      "createdAt": "<string>",
      "updatedAt": "<string>"
    }
  ],
  "meta": {
    "total": 123,
    "totalInbox": 123,
    "totalSpam": 123
  },
  "pagination": {
    "totalPages": 123,
    "currentPage": 123,
    "nextPage": 123,
    "previousPage": 123
  }
}

Headers

api-key
string
required

The API key.

Query Parameters

formId
string
required

The unique ID of the form.

Search for a submission by its content.

page
number
default:
1

The page number for pagination.

Required range: x > 0
pageSize
number
default:
20

The number of items per page.

Required range: 0 < x < 100

Response

200
application/json
A list of submissions.
data
object[]
required

The list of submissions.

meta
object
required

Extra metadata about the submissions response.

pagination
object
required

Pagination metadata.