> ## 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.

# Export a form’s submissions as CSV

> The form’s newest 10,000 submissions as one CSV string inside JSON.

```ts TypeScript wrap theme={"dark"}
import { createSiteClient } from '@fetchski/attract-cms-sdk';

const site = createSiteClient();
const formSubmissionExport = await site.formSubmissions().exportFormSubmissions({ formId: 'clx8m2k4p0000a1b2c3d4e5f6' });
```

```json 200 wrap theme={"dark"}
{
  "filename": "Acme_Contact_Submissions_2026-10-01.csv",
  "csv": "Example csv",
  "rows": 1,
  "total": 1,
  "truncated": true
}
```

## In your app

A function makes the call on the client it is given, so your code passes the real one and a test passes a fake.

**1. Add the function**

```ts src/attract/export-form-submissions.ts theme={"dark"}
import type { SiteClient } from '@fetchski/attract-cms-sdk';

export async function exportFormSubmissions(site: SiteClient) {
  return site.formSubmissions().exportFormSubmissions({ formId: 'clx8m2k4p0000a1b2c3d4e5f6' });
}
```

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

**2. Call it**

A script makes the client once and calls the function:

```ts scripts/export-form-submissions.ts theme={"dark"}
import { createSiteClient } from '@fetchski/attract-cms-sdk';
import { exportFormSubmissions } from '../src/attract/export-form-submissions.ts';

const site = createSiteClient();
console.log(await exportFormSubmissions(site));
```

```bash Terminal theme={"dark"}
node --env-file=.env scripts/export-form-submissions.ts
```

A route handler, a job or a queue worker calls it the same way.

A signed-in user also needs the `form-submissions:export` permission: one holding only `form-submissions:view` gets 403 (`data.permission` names it).

> [accordion] Required parameters
>
> One object, e.g. `exportFormSubmissions({ 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] Returns
>
> A `FormSubmissionExport`. The CSV. Read its properties (`formSubmissionExport.filename`): each says whether the site always sends it.
>
> **filename** `string`
>
> **Always sent.**
>
> **csv** `string`
>
> **Always sent.** The CSV (UTF-8 with a byte-order mark, CRLF lines): Submitted, Visitor ID (only when a row has one), then every field. A cell starting `=`, `+`, `-`, `@` or a tab is prefixed with `'` so a spreadsheet never runs it.
>
> **rows** `number`
>
> **Always sent.** Rows in `csv`.
>
> **total** `number`
>
> **Always sent.** Submissions the form has.
>
> **truncated** `boolean`
>
> **Always sent.** True when `rows` \< `total`: the newest 10,000 only.

> [accordion] Errors
>
> Nothing to catch: the SDK retries what is safe, and throws the rest as the classes below; catch only what you want to react to (see [Errors and testing](https://docs.fetchski-attract.com/typescript/errors.md)).
>
> **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 your sites (`createSiteClients()`) don’t have.
>
> **Retried first:** No: nothing was sent. **Read:** `message`, `slug`.
>
> **SiteConfigurationError** `setup`
>
> The client’s settings are wrong: no `FETCHSKI_ATTRACT_URL` (or `baseUrl`), or a malformed API key.
>
> **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) on the client for longer.

## Test it

It calls the function above with a fake client: the fake answers every call with a valid example, so nothing leaves your machine and no settings or key are needed. Run it with `node --test`.

```ts tests/formSubmissions-exportFormSubmissions.test.ts theme={"dark"}
import { test } from 'node:test';
import { fakeSite } from '@fetchski/attract-cms-sdk/testing';
import { exportFormSubmissions } from '../src/attract/export-form-submissions.ts';

test('formSubmissions.exportFormSubmissions', async () => {
  const site = fakeSite();
  await exportFormSubmissions(site);
  site.assertCalled('formSubmissions.exportFormSubmissions');
});
```

**Answer with your own values:** fake `formSubmissions.exportFormSubmissions` with `factories.FormSubmissionExport({...})`, the fields you give over a valid example.

```ts tests/formSubmissions-exportFormSubmissions-answer.test.ts theme={"dark"}
import assert from 'node:assert/strict';
import { test } from 'node:test';
import { factories, fakeSite } from '@fetchski/attract-cms-sdk/testing';

test('formSubmissions.exportFormSubmissions answers your values', async () => {
  const site = fakeSite({
    'formSubmissions.exportFormSubmissions': factories.FormSubmissionExport({ filename: 'Your value' })
  });
  const formSubmissionExport = await site.formSubmissions().exportFormSubmissions({ formId: 'clx8m2k4p0000a1b2c3d4e5f6' });
  assert.equal(formSubmissionExport.filename, 'Your value');
});
```

## Related

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

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

> [card] [GET /form-submission/export](https://docs.fetchski-attract.com/api-reference/form-submissions/export-a-form’s-submissions-as-csv.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.