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

```php Laravel wrap theme={"dark"}
use Fetchski\AttractCmsLaravel\Facades\Attract;

$formSubmissionExport = Attract::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 controller answers a route on your app: it calls `exportFormSubmissions()` and returns the answer.

**1. Add the controller**

```php app/Http/Controllers/ExportFormSubmissionsController.php theme={"dark"}
<?php

declare(strict_types=1);

namespace App\Http\Controllers;

use Fetchski\AttractCmsLaravel\Data\FormSubmissionExport;
use Fetchski\AttractCmsLaravel\Facades\Attract;

final class ExportFormSubmissionsController
{
    public function __invoke(): FormSubmissionExport
    {
        return Attract::formSubmissions()->exportFormSubmissions(formId: 'clx8m2k4p0000a1b2c3d4e5f6');
    }
}
```

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

**2. Add the route**

```php routes/web.php theme={"dark"}
use App\Http\Controllers\ExportFormSubmissionsController;
use Illuminate\Support\Facades\Route;

Route::get('/form-submission/export', ExportFormSubmissionsController::class);
```

**3. Call it**

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

With `php artisan serve` running, it prints its answer as JSON.

> [!TIP]
>
> To keep the call in an Action instead, this writes `app/Actions/Attract/ExportFormSubmissions.php` (an invokable Action that calls `exportFormSubmissions()`) and its test under `tests/Feature/Actions/Attract/` (Pest when your app has it):
>
> ```bash Terminal theme={"dark"}
> php artisan make:attract-action formSubmissions.exportFormSubmissions
> ```

## Call it from the terminal

```bash Terminal theme={"dark"}
php artisan attract:call formSubmissions.exportFormSubmissions formId=clx8m2k4p0000a1b2c3d4e5f6
```

It calls `exportFormSubmissions()` on your default site and prints its answer as JSON. See [Call any method from the terminal](https://docs.fetchski-attract.com/call-command.md) for every argument type.

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
>
> Named arguments, e.g. `exportFormSubmissions(formId: …)`; leave out the optional ones.
>
> **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` (`Fetchski\AttractCmsLaravel\Data\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** `int`
>
> **Always sent.** Rows in `csv`.
>
> **total** `int`
>
> **Always sent.** Submissions the form has.
>
> **truncated** `bool`
>
> **Always sent.** True when `rows` \< `total`: the newest 10,000 only.

> [accordion] Errors
>
> Nothing to catch: the SDK retries what is safe, and Laravel logs and renders the rest (see [Errors and testing](https://docs.fetchski-attract.com/laravel/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`
>
> `Attract::site('acme')` named a slug that isn’t under `sites` in `config/fetchski-attract.php`.
>
> **Retried first:** No: nothing was sent. **Read:** `getMessage()`, `$e->slug`.
>
> **SiteConfigurationError** `setup`
>
> The site’s config entry is wrong: no `url`, a malformed `api_key`, a key filed under another slug, or no default site.
>
> **Retried first:** No: nothing was sent. **Read:** `getMessage()` (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` in `config/fetchski-attract.php` for longer.

## Test it

It calls the route above with the SDK faked: the fake answers every call with a valid example, so nothing leaves your machine and no config or key is needed. Save it as `tests/Feature/ExportFormSubmissionsTest.php`, then run your tests:

```php tests/Feature/ExportFormSubmissionsTest.php theme={"dark"}
<?php

declare(strict_types=1);

namespace Tests\Feature;

use Fetchski\AttractCmsLaravel\Facades\Attract;
use Tests\TestCase;

final class ExportFormSubmissionsTest extends TestCase
{
    public function test_export_form_submissions(): void
    {
        Attract::fake();

        $this->getJson('/form-submission/export')->assertOk();

        Attract::assertCalled('formSubmissions.exportFormSubmissions');
    }
}
```

```bash Terminal theme={"dark"}
php artisan test
```

**Answer with your own values:** fake `formSubmissions.exportFormSubmissions` with `FormSubmissionExport::factory()->make([...])`, the fields you give over a valid example.

```php tests/Feature/ExportFormSubmissionsAnswerTest.php theme={"dark"}
<?php

declare(strict_types=1);

namespace Tests\Feature;

use Fetchski\AttractCmsLaravel\Data\FormSubmissionExport;
use Fetchski\AttractCmsLaravel\Facades\Attract;
use Tests\TestCase;

final class ExportFormSubmissionsAnswerTest extends TestCase
{
    public function test_export_form_submissions_answers_your_values(): void
    {
        Attract::fake([
            'formSubmissions.exportFormSubmissions' => FormSubmissionExport::factory()->make(['filename' => 'Your value']),
        ]);

        $formSubmissionExport = Attract::formSubmissions()->exportFormSubmissions(formId: 'clx8m2k4p0000a1b2c3d4e5f6');

        $this->assertSame('Your value', $formSubmissionExport->filename);
    }
}
```

## Related

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

> [card] [List a form’s submissions](https://docs.fetchski-attract.com/laravel/reference/form-submissions/list-form-submissions.md)
>
> `Attract::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.