> ## Documentation Index
> Fetch the complete documentation index at: https://docs.fetchski-attract.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List a form’s submissions

> A form’s submissions, newest first, a page at a time.

```ts AdonisJS wrap theme={"dark"}
import app from '@adonisjs/core/services/app'
import { SiteClient } from '@fetchski/attract-cms-sdk'

const site = await app.container.make(SiteClient)
const formSubmissionPage = await site.formSubmissions().listFormSubmissions({ formId: 'clx8m2k4p0000a1b2c3d4e5f6' })
```

```json 200 wrap theme={"dark"}
{
  "submissions": [
    {
      "_id": "66f1c2a9e4b0a1b2c3d4e5f7",
      "createdAt": "2026-10-01T14:05:10.000Z",
      "visitorId": "3f2b8c1e-5d4a-4e6f-9a7b-1c2d3e4f5a6b",
      "conversionEvents": [
        {
          "eventId": "9b1d4c2e-7f3a-4b5c-8d6e-0a1b2c3d4e5f",
          "conversionId": "clx8k2m0a0009abcd1234efgh",
          "title": "Contact form sent"
        }
      ],
      "data": {
        "name": "Sam Rivera",
        "email": "sam@example.com",
        "message": "Do you offer weekend hours?"
      }
    }
  ],
  "columns": [
    {
      "key": "Example key",
      "label": "Example label",
      "choices": {
        "key": "Example value"
      }
    }
  ],
  "total": 1,
  "page": 1,
  "perPage": 20,
  "totalPages": 1
}
```

## In your app

A controller answers a route on your app: it calls `listFormSubmissions()` and returns the answer.

**1. Add the controller**

```ts app/controllers/list_form_submissions_controller.ts theme={"dark"}
import { inject } from '@adonisjs/core'
import { SiteClient } from '@fetchski/attract-cms-sdk'

@inject()
export default class ListFormSubmissionsController {
  constructor(protected site: SiteClient) {}

  async handle() {
    return this.site.formSubmissions().listFormSubmissions({ formId: 'clx8m2k4p0000a1b2c3d4e5f6' })
  }
}
```

The other values are the example’s: take yours from the request, a form or your database.

**2. Add the route**

```ts start/routes.ts theme={"dark"}
import router from '@adonisjs/core/services/router'

const ListFormSubmissionsController = () => import('#controllers/list_form_submissions_controller')

router.get('/form-submission/list', [ListFormSubmissionsController])
```

**3. Call it**

```bash Terminal theme={"dark"}
curl http://localhost:3333/form-submission/list
```

With `node ace serve` running, it prints its answer as JSON.

> [accordion] Required parameters
>
> One object, e.g. `listFormSubmissions({ formId })`; leave out the optional fields.
>
> **formId** `string` *required*
>
> **Required.** The form: its document ID, in either form (`<aposDocId>` or `<aposDocId>:<locale>:<mode>`), from the forms list.

> [accordion] Optional parameters
>
> **page** `number | null | undefined`
>
> **Optional.** Leave it out and the site uses `1`. Page number, from 1 (a page past the end answers the last page).
>
> **perPage** `number | null | undefined`
>
> **Optional.** Leave it out and the site uses `25`. Submissions per page. 1 to 100.

> [accordion] Returns
>
> A `FormSubmissionPage`. A page of submissions. Read its properties (`formSubmissionPage.submissions`): each says whether the site always sends it. The example answer is the site’s wire JSON: one key differs from the property names (`_id` → `id`).
>
> **submissions** `readonly FormSubmission[]`
>
> **Always sent.** A list of `FormSubmission`.
>
> **FormSubmission**
>
> One submission, exactly as the visitor sent it.
>
> **id** `string`
>
> **Always sent.**
>
> **createdAt** `Date`
>
> **Always sent.** Format: an ISO 8601 date and time.
>
> **visitorId** `string | null`
>
> **Always sent, can be `null`.** The visitor, when tracking is on and they consented: joins the request log.
>
> **conversionEvents** `readonly FormSubmissionConversionEventsItem[]`
>
> **Always sent.** A list of `FormSubmissionConversionEventsItem`. The conversion events this submission recorded.
>
> **FormSubmissionConversionEventsItem**
>
> **eventId** `string`
>
> **Always sent.** Read it in the Conversion Data API.
>
> **conversionId** `string`
>
> **Always sent.**
>
> **title** `string`
>
> **Always sent.** The conversion’s name; empty if it is gone.
>
> **data** `Readonly\<Record\<string, unknown\>\>`
>
> **Always sent.** Field name → value, as the form defined its fields.
>
> **columns** `readonly FormSubmissionColumn[]`
>
> **Always sent.** A list of `FormSubmissionColumn`. Every `data` key seen in the form’s recent submissions, in first-seen order: stable from page to page.
>
> **FormSubmissionColumn**
>
> **key** `string`
>
> **Always sent.** The `data` key.
>
> **label** `string`
>
> **Always sent.** The form’s label for this field; the key, humanized, when the form has no such field.
>
> **choices** `Readonly\<Record\<string, string\>\>`
>
> **Sometimes sent:** `undefined` when the site leaves it out. A select, radio or checkboxes field’s choices, stored value → the label visitors saw. Absent for other fields.
>
> **total** `number`
>
> **Always sent.**
>
> **page** `number`
>
> **Always sent.**
>
> **perPage** `number`
>
> **Always sent.**
>
> **totalPages** `number`
>
> **Always sent.** At least 1.

> [accordion] Errors
>
> Nothing to catch: the SDK retries what is safe, and throws the rest as the classes below. Your exception handler turns them into your app’s own answers, once for every call (see [Map SDK errors to responses](https://docs.fetchski-attract.com/adonisjs/calling-the-api.md#map-sdk-errors-to-responses)); catch only what you want to react to here.
>
> **ValidationFailed** `400`
>
> The request is not valid; the message says which part and how to fix it.
>
> **Retried first:** No. **Read:** `errors` (field → messages), `siteMessage`.
>
> **AuthenticationFailed** `401`
>
> The API key is missing, malformed, unknown, disabled, expired or archived, or a request its signing mode requires to be signed is not.
>
> **Retried first:** No. **Read:** `siteMessage`, `errorName`, `data`.
>
> **Forbidden** `403`
>
> The API key lacks the scope this route needs (the message names it) or is used from outside its allowlist; or, on a route that answers 403 to everyone it refuses, the caller may not use it.
>
> **Retried first:** No. **Read:** `siteMessage`, `errorName`, `data`.
>
> **NotFound** `404`
>
> Nothing matches the identifier, or the caller may not use this route at all (it is not advertised).
>
> **Retried first:** No. **Read:** `siteMessage`, `errorName`, `data`.
>
> **RateLimited** `429`
>
> The key used up its per-minute limit. Still, after the client’s own waits and retries.
>
> **Retried first:** Yes: the client waits `Retry-After` (1 s when absent; over 60 s it gives up at once) and retries, up to `retries` times (2 by default). **Read:** `retryAfter` (seconds, or null), `siteMessage`.
>
> **SiteError** `5xx`
>
> The site failed (or something in front of it did). Its logs say why.
>
> **Retried first:** A 502, 503 or 504: yes, after 0.5 s then 1 s. A 500: no. **Read:** `siteMessage`, `errorName`, `data`.
>
> **SiteUnreachable** `no answer`
>
> No answer: DNS, a refused connection, TLS, or the timeout (15 s per attempt by default).
>
> **Retried first:** Yes, after 0.5 s then 1 s. **Read:** `reason`, `neverConnected`.
>
> **RequestNotSent** `not sent`
>
> The client refused to send it (e.g. a path segment of `..`); the site never saw it.
>
> **Retried first:** No. **Read:** `reason` (what to change).
>
> **SiteRequestFailed** `any other`
>
> Any other status, or a success whose JSON doesn’t match this SDK version’s types (update the SDK).
>
> **Retried first:** No. **Read:** `reason`, `status`.
>
> **UnknownSite** `setup`
>
> `sites.forSite('acme')` named a slug `config/attract.ts` doesn’t list (with the keys in the database: no row in `attract_api_keys`).
>
> **Retried first:** No: nothing was sent. **Read:** `message`, `slug`.
>
> **SiteConfigurationError** `setup`
>
> The site’s entry is wrong: a malformed `baseUrl` or key, a key filed under another slug, or no default site. `node ace attract:check` names the fix.
>
> **Retried first:** No: nothing was sent. **Read:** `message` (what to fix).

## Behavior

* **Access:** an API key with `forms:read`, or `forms:all`, or `admin:all`, or a signed-in user holding the `form-submissions:view` permission. Other callers get 404.
* **Rate limit:** the key’s own reads-per-minute limit, set when the key is created (default 600); over it, 429 with `Retry-After`. The client waits and retries for you; you see `RateLimited` only if that runs out.
* **Retries:** a read is safe to repeat: the client retries it on no answer, a 502/503/504 and a 429.
* **Timeout:** 15 s per attempt by default; raise `timeout` (milliseconds) in `config/attract.ts` for longer.
* **Paging:** one page per call. To walk them all, use `listFormSubmissionsAll()` (see More examples): it asks for the next page as you iterate, and stops after page `totalPages`.

## More examples

`listFormSubmissionsAll()` takes `listFormSubmissions()`’s arguments except `page`.

```ts Every page wrap theme={"dark"}
import app from '@adonisjs/core/services/app'
import { SiteClient } from '@fetchski/attract-cms-sdk'

const site = await app.container.make(SiteClient)
for await (const formSubmission of site.formSubmissions().listFormSubmissionsAll({ formId: 'clx8m2k4p0000a1b2c3d4e5f6' })) {
  console.log(formSubmission) // the next page is fetched as you iterate
}
```

## Test it

It calls the controller above with the SDK faked: `fakeAttract()` puts the fake in the container for this one test, and it answers every call with a valid example, so nothing leaves your machine and no key is read. Save it as `tests/unit/form_submissions_list_form_submissions.spec.ts`, then run your tests:

```ts tests/unit/form_submissions_list_form_submissions.spec.ts theme={"dark"}
import { test } from '@japa/runner'
import app from '@adonisjs/core/services/app'
import { fakeAttract } from '@fetchski/attract-cms-adonis/testing'
import ListFormSubmissionsController from '#controllers/list_form_submissions_controller'

test('formSubmissions.listFormSubmissions', async () => {
  const site = fakeAttract()

  const controller = await app.container.make(ListFormSubmissionsController)
  await controller.handle()

  site.assertCalled('formSubmissions.listFormSubmissions')
})
```

```bash Terminal theme={"dark"}
node ace test
```

**Answer with your own values:** fake `formSubmissions.listFormSubmissions` with a `sequence()` of pages, each `factories.FormSubmissionPage({...})`, and walk `listFormSubmissionsAll()`.

```ts tests/unit/form_submissions_list_form_submissions_answers.spec.ts theme={"dark"}
import { test } from '@japa/runner'
import { factories, fakeAttract, sequence } from '@fetchski/attract-cms-adonis/testing'

test('formSubmissions.listFormSubmissions answers your values', async ({ assert }) => {
  const site = fakeAttract({
    'formSubmissions.listFormSubmissions': sequence(
      factories.FormSubmissionPage({ page: 1, totalPages: 2 }),
      factories.FormSubmissionPage({ page: 2, totalPages: 2 })
    ),
  })

  const walked: unknown[] = []
  for await (const formSubmission of site.formSubmissions().listFormSubmissionsAll({ formId: 'clx8m2k4p0000a1b2c3d4e5f6' })) {
    walked.push(formSubmission)
  }
  assert.lengthOf(walked, 2)
})
```

To fake `listFormSubmissionsAll()`, answer `formSubmissions.listFormSubmissions` (the walk calls it page by page): a `sequence()` of answers for several pages.

## Related

> [card] [List forms and their submission counts](https://docs.fetchski-attract.com/adonisjs/reference/form-submissions/list-submission-forms.md)
>
> `site.formSubmissions().listSubmissionForms()`

> [card] [Export a form’s submissions as CSV](https://docs.fetchski-attract.com/adonisjs/reference/form-submissions/export-form-submissions.md)
>
> `site.formSubmissions().exportFormSubmissions()`

> [card] [GET /form-submission/list](https://docs.fetchski-attract.com/api-reference/form-submissions/list-a-form’s-submissions.md)
>
> The endpoint this calls, in the API reference: the HTTP request and answer, and every rule the site checks.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.