List a form’s submissions

import { createSiteClient } from '@fetchski/attract-cms-sdk';

const site = createSiteClient();
const formSubmissionPage = await site.formSubmissions().listFormSubmissions({ formId: 'clx8m2k4p0000a1b2c3d4e5f6' });

{
  "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
}

import { createSiteClient } from '@fetchski/attract-cms-sdk';

const site = createSiteClient();
const formSubmissionPage = await site.formSubmissions().listFormSubmissions({ formId: 'clx8m2k4p0000a1b2c3d4e5f6' });

{
  "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 function makes the call on the client it is given, so your code passes the real one and a test passes a fake.

Add the function

src/attract/list-form-submissions.ts

import type { SiteClient } from '@fetchski/attract-cms-sdk';

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

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

Call it

A script makes the client once and calls the function:

scripts/list-form-submissions.ts

import { createSiteClient } from '@fetchski/attract-cms-sdk';
import { listFormSubmissions } from '../src/attract/list-form-submissions.ts';

const site = createSiteClient();
console.log(await listFormSubmissions(site));

Terminal

node --env-file=.env scripts/list-form-submissions.ts

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

Required parameters

One object, e.g. listFormSubmissions({ formId }); leave out the optional fields.

string

required

Required. The form: its document ID, in either form (<aposDocId> or <aposDocId>:<locale>:<mode>), from the forms list.

Optional parameters

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

number | null | undefined

Optional. Leave it out and the site uses 25. Submissions per page. 1 to 100.

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

readonly FormSubmission[]

Always sent. A list of FormSubmission.

Show FormSubmission

One submission, exactly as the visitor sent it.

string

Always sent.

Date

Always sent. Format: an ISO 8601 date and time.

string | null

Always sent, can be null. The visitor, when tracking is on and they consented: joins the request log.

readonly FormSubmissionConversionEventsItem[]

Always sent. A list of FormSubmissionConversionEventsItem. The conversion events this submission recorded.

Show FormSubmissionConversionEventsItem

string

Always sent. Read it in the Conversion Data API.

string

Always sent.

string

Always sent. The conversion’s name; empty if it is gone.

Readonly<Record<string, unknown>>

Always sent. Field name → value, as the form defined its fields.

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.

Show FormSubmissionColumn

string

Always sent. The data key.

string

Always sent. The form’s label for this field; the key, humanized, when the form has no such field.

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.

number

Always sent.

number

Always sent.

number

Always sent.

number

Always sent. At least 1.

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

400

The request is not valid; the message says which part and how to fix it.Retried first: No. Read: errors (field → messages), siteMessage.

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.

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.

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.

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.

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.

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.

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

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.

setup

sites.forSite('acme') named a slug your sites (createSiteClients()) don’t have.Retried first: No: nothing was sent. Read: message, slug.

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

import { createSiteClient } from '@fetchski/attract-cms-sdk';

const site = createSiteClient();
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 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.

tests/formSubmissions-listFormSubmissions.test.ts

import { test } from 'node:test';
import { fakeSite } from '@fetchski/attract-cms-sdk/testing';
import { listFormSubmissions } from '../src/attract/list-form-submissions.ts';

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

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

tests/formSubmissions-listFormSubmissions-answer.test.ts

import assert from 'node:assert/strict';
import { test } from 'node:test';
import { factories, fakeSite, sequence } from '@fetchski/attract-cms-sdk/testing';

test('formSubmissions.listFormSubmissions answers your values', async () => {
  const site = fakeSite({
    '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.equal(walked.length, 2);
});

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

List forms and their submission counts

site.formSubmissions().listSubmissionForms()

Export a form’s submissions as CSV

site.formSubmissions().exportFormSubmissions()

GET /form-submission/list

The endpoint this calls, in the API reference: the HTTP request and answer, and every rule the site checks.

import { createSiteClient } from '@fetchski/attract-cms-sdk';

const site = createSiteClient();
const formSubmissionPage = await site.formSubmissions().listFormSubmissions({ formId: 'clx8m2k4p0000a1b2c3d4e5f6' });

{
  "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
}

Get started

Using the SDK

Going further

Pages & Site

Content

Media

Forms

Ads & Conversions

Analytics

In your app

Behavior

More examples

Test it

List forms and their submission counts

Export a form’s submissions as CSV

GET /form-submission/list

In your app

Behavior

More examples

Test it

Related

List forms and their submission counts

Export a form’s submissions as CSV

GET /form-submission/list