> ## 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 forms and their submission counts

> Every form, by title, with how many submissions it holds.

```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 listSubmissionForms = await site.formSubmissions().listSubmissionForms()
```

```json 200 wrap theme={"dark"}
{
  "forms": [
    {
      "aposDocId": "clx8k2m0a0007abcd1234efgh",
      "title": "Contact",
      "count": 42
    }
  ]
}
```

## In your app

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

**1. Add the controller**

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

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

  async handle() {
    return this.site.formSubmissions().listSubmissionForms()
  }
}
```

**2. Add the route**

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

const ListSubmissionFormsController = () => import('#controllers/list_submission_forms_controller')

router.get('/form-submission/forms', [ListSubmissionFormsController])
```

**3. Call it**

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

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

> [accordion] Parameters
>
> None: call it with no arguments.

> [accordion] Returns
>
> A `ListSubmissionFormsResponse`. The forms. Read its properties (`listSubmissionForms.forms`): each says whether the site always sends it.
>
> **forms** `readonly FormSummary[]`
>
> **Always sent.** A list of `FormSummary`.
>
> **FormSummary**
>
> **aposDocId** `string`
>
> **Always sent.** Pass it as `formId`.
>
> **title** `string`
>
> **Always sent.**
>
> **count** `number`
>
> **Always sent.** Submissions stored for it.

> [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.
>
> **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.

## 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_submission_forms.spec.ts`, then run your tests:

```ts tests/unit/form_submissions_list_submission_forms.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 ListSubmissionFormsController from '#controllers/list_submission_forms_controller'

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

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

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

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

## Related

> [card] [List a form’s submissions](https://docs.fetchski-attract.com/adonisjs/reference/form-submissions/list-form-submissions.md)
>
> `site.formSubmissions().listFormSubmissions()`

> [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/forms](https://docs.fetchski-attract.com/api-reference/form-submissions/list-forms-and-their-submission-counts.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.