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

# Paperform API reference

> API reference for the Paperform plugin in Corsair: every `paperform.api.*` operation with its input and output types, taken from the plugin's Zod schemas.

> [!NOTE]
>
> **New to Corsair?** See [API access](https://docs.corsair.dev/concepts/api.md), [authentication](https://docs.corsair.dev/concepts/auth.md), and [error handling](https://docs.corsair.dev/concepts/error-handling).

## Coupons

### create

`coupons.create`

Create a coupon code on a form, with a fixed amount or percentage off.

**Risk:** `write`

```ts theme={null}
await corsair.paperform.api.coupons.create({ form: 'eqadkzns', code: 'WELCOME10', enabled: true, target: 'price', discountPercentage: 10 });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `form` | `string` | Yes | Form slug, custom slug or id (from forms.list). |
| `code` | `string` | Yes | Coupon code. |
| `enabled` | `boolean` | No | — |
| `target` | `price \| subscription` | No | What the discount applies to. |
| `discountAmount` | `number` | No | — |
| `discountPercentage` | `number` | No | — |
| `expiresAt` | `string \| null` | No | ISO date-time the coupon stops working. null never expires. |

`POST /v1/forms/{slug_or_id}/coupons`.

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `coupon` | `object` | Yes | — |

> [accordion] coupon full type
>
> ```ts theme={null}
> {
>   code: string,
>   enabled?: boolean,
>   target?: string | null,
>   discountAmount?: number | null,
>   discountPercentage?: number | null,
>   expiresAt?: string | null
> }
> ```

***

### delete

`coupons.delete`

Delete a coupon code from a form.

**Risk:** `destructive`

```ts theme={null}
await corsair.paperform.api.coupons.delete({ form: 'eqadkzns', code: 'WELCOME10' });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `form` | `string` | Yes | Form slug, custom slug or id (from forms.list). |
| `code` | `string` | Yes | Coupon code. |

`DELETE /v1/forms/{slug_or_id}/coupons/{code}`.

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `deleted` | `true` | Yes | — |

***

### get

`coupons.get`

Get one coupon on a form by code.

**Risk:** `read`

```ts theme={null}
await corsair.paperform.api.coupons.get({ form: 'eqadkzns', code: 'WELCOME10' });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `form` | `string` | Yes | Form slug, custom slug or id (from forms.list). |
| `code` | `string` | Yes | Coupon code. |

`GET /v1/forms/{slug_or_id}/coupons/{code}`.

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `coupon` | `object` | Yes | — |

> [accordion] coupon full type
>
> ```ts theme={null}
> {
>   code: string,
>   enabled?: boolean,
>   target?: string | null,
>   discountAmount?: number | null,
>   discountPercentage?: number | null,
>   expiresAt?: string | null
> }
> ```

***

### list

`coupons.list`

List the coupon codes on a form.

**Risk:** `read`

```ts theme={null}
await corsair.paperform.api.coupons.list({ form: 'eqadkzns' });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `form` | `string` | Yes | Form slug, custom slug or id (from forms.list). |

`GET /v1/forms/{slug_or_id}/coupons`.

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `coupons` | `object[]` | Yes | — |

> [accordion] coupons full type
>
> ```ts theme={null}
> {
>   code: string,
>   enabled?: boolean,
>   target?: string | null,
>   discountAmount?: number | null,
>   discountPercentage?: number | null,
>   expiresAt?: string | null
> }[]
> ```

***

### update

`coupons.update`

Change a coupon (enable or disable, discount, expiry). Fields you leave out stay as they are.

**Risk:** `write`

```ts theme={null}
await corsair.paperform.api.coupons.update({ form: 'eqadkzns', code: 'WELCOME10', enabled: false });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `form` | `string` | Yes | Form slug, custom slug or id (from forms.list). |
| `code` | `string` | Yes | Coupon code. |
| `enabled` | `boolean` | No | — |
| `target` | `price \| subscription` | No | What the discount applies to. |
| `discountAmount` | `number` | No | — |
| `discountPercentage` | `number` | No | — |
| `expiresAt` | `string \| null` | No | ISO date-time the coupon stops working. null never expires. |

`PUT /v1/forms/{slug_or_id}/coupons/{code}`.

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `coupon` | `object` | Yes | — |

> [accordion] coupon full type
>
> ```ts theme={null}
> {
>   code: string,
>   enabled?: boolean,
>   target?: string | null,
>   discountAmount?: number | null,
>   discountPercentage?: number | null,
>   expiresAt?: string | null
> }
> ```

***

## Fields

### list

`fields.list`

List the questions on a form: each field key, title and type. Submission answers are keyed by these field keys.

**Risk:** `read`

```ts theme={null}
await corsair.paperform.api.fields.list({ form: 'eqadkzns' });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `form` | `string` | Yes | Form slug, custom slug or id (from forms.list). |
| `search` | `string` | No | Text to search for. |

`GET /v1/forms/{slug_or_id}/fields`.

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `fields` | `object[]` | Yes | — |

> [accordion] fields full type
>
> ```ts theme={null}
> {
>   key: string,
>   title?: string | null,
>   type?: string | null,
>   required?: boolean | null,
>   custom_key?: string | null
> }[]
> ```

***

## Files

### sign

`files.sign`

Get a signed download link for a file uploaded in a submission. Links last 7 days.

**Risk:** `read`

```ts theme={null}
await corsair.paperform.api.files.sign({ url: 'https://paperform.co/file/s3.amazonaws.com/paperform/u-1/1/2019-04-14/58p3u6p/file.pdf' });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `url` | `string` | Yes | File URL from a submission answer (a paperform.co file link). |

`POST /v1/files/sign`. Only works for files uploaded to your own forms.

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `fileUrl` | `string` | Yes | — |
| `storageUrl` | `string` | No | — |
| `expiresAt` | `string \| null` | No | — |

***

## Forms

### get

`forms.get`

Get one form by slug, custom slug or id.

**Risk:** `read`

```ts theme={null}
await corsair.paperform.api.forms.get({ form: 'eqadkzns' });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `form` | `string` | Yes | Form slug, custom slug or id (from forms.list). |

`GET /v1/forms/{slug_or_id}`.

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `form` | `object` | Yes | — |

> [accordion] form full type
>
> ```ts theme={null}
> {
>   id: string,
>   slug?: string | null,
>   custom_slug?: string | null,
>   space_id?: string,
>   title?: string | null,
>   description?: string | null,
>   url?: string | null,
>   live?: boolean,
>   submission_count?: number,
>   created_at_utc?: string | null,
>   updated_at_utc?: string | null
> }
> ```

***

### list

`forms.list`

List forms, newest first by default. Filter with search, page with limit and skip.

**Risk:** `read`

```ts theme={null}
await corsair.paperform.api.forms.list({ search: 'order', limit: 20 });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `search` | `string` | No | Text to search for. |
| `limit` | `number` | No | Results per page. Paperform defaults to 20. |
| `skip` | `number` | No | Results to skip. |
| `afterId` | `string` | No | Only results after this id. |
| `beforeId` | `string` | No | Only results before this id. |
| `afterDate` | `string` | No | Only results created after this date (YYYY-MM-DD or ISO). |
| `beforeDate` | `string` | No | Only results created before this date (YYYY-MM-DD or ISO). |
| `sort` | `ASC \| DESC` | No | Order by creation date. |

`GET /v1/forms`. Stores id, title, slug, space id, live flag and submission count.

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `forms` | `object[]` | Yes | — |
| `page` | `object` | Yes | — |

> [accordion] forms full type
>
> ```ts theme={null}
> {
>   id: string,
>   slug?: string | null,
>   custom_slug?: string | null,
>   space_id?: string,
>   title?: string | null,
>   description?: string | null,
>   url?: string | null,
>   live?: boolean,
>   submission_count?: number,
>   created_at_utc?: string | null,
>   updated_at_utc?: string | null
> }[]
> ```

> [accordion] page full type
>
> ```ts theme={null}
> {
>   total?: number,
>   hasMore?: boolean,
>   limit?: number,
>   skip?: number
> }
> ```

***

## Partial Submissions

### get

`partialSubmissions.get`

Get one partial submission of a form.

**Risk:** `read`

```ts theme={null}
await corsair.paperform.api.partialSubmissions.get({ form: 'eqadkzns', id: '6afc3d79939666bf340d8a77' });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `form` | `string` | Yes | Form slug, custom slug or id (from forms.list). |
| `id` | `string` | Yes | Submission id. |

`GET /v1/forms/{slug_or_id}/partial-submissions/{id}`.

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `partialSubmission` | `object` | Yes | — |

> [accordion] partialSubmission full type
>
> ```ts theme={null}
> {
>   id: string,
>   form_id?: string | null,
>   data?: Record<string, any>,
>   last_answered?: string | null,
>   submitted_at_utc?: string | null,
>   created_at_utc?: string | null,
>   updated_at_utc?: string | null
> }
> ```

***

### list

`partialSubmissions.list`

List partial (unfinished) submissions of a form. Paperform keeps them only when partial submissions are turned on for the form.

**Risk:** `read`

```ts theme={null}
await corsair.paperform.api.partialSubmissions.list({ form: 'eqadkzns' });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `form` | `string` | Yes | Form slug, custom slug or id (from forms.list). |
| `limit` | `number` | No | Results per page. Paperform defaults to 20. |
| `skip` | `number` | No | Results to skip. |
| `afterId` | `string` | No | Only results after this id. |
| `beforeId` | `string` | No | Only results before this id. |
| `afterDate` | `string` | No | Only results created after this date (YYYY-MM-DD or ISO). |
| `beforeDate` | `string` | No | Only results created before this date (YYYY-MM-DD or ISO). |
| `sort` | `ASC \| DESC` | No | Order by creation date. |

`GET /v1/forms/{slug_or_id}/partial-submissions`.

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `partialSubmissions` | `object[]` | Yes | — |
| `page` | `object` | Yes | — |

> [accordion] partialSubmissions full type
>
> ```ts theme={null}
> {
>   id: string,
>   form_id?: string | null,
>   data?: Record<string, any>,
>   last_answered?: string | null,
>   submitted_at_utc?: string | null,
>   created_at_utc?: string | null,
>   updated_at_utc?: string | null
> }[]
> ```

> [accordion] page full type
>
> ```ts theme={null}
> {
>   total?: number,
>   hasMore?: boolean,
>   limit?: number,
>   skip?: number
> }
> ```

***

## Products

### get

`products.get`

Get one product on a form by SKU.

**Risk:** `read`

```ts theme={null}
await corsair.paperform.api.products.get({ form: 'eqadkzns', sku: 'tshirt-small' });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `form` | `string` | Yes | Form slug, custom slug or id (from forms.list). |
| `sku` | `string` | Yes | Product SKU. |

`GET /v1/forms/{slug_or_id}/products/{sku}`.

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `product` | `object` | Yes | — |

> [accordion] product full type
>
> ```ts theme={null}
> {
>   SKU?: string | null,
>   name?: string | null,
>   price?: number | string | null,
>   quantity?: number | string | null,
>   minimum?: number | string | null,
>   maximum?: number | string | null,
>   discountable?: boolean | null,
>   sold?: number | string | null
> }
> ```

***

### list

`products.list`

List the products sold on a form, with price and stock.

**Risk:** `read`

```ts theme={null}
await corsair.paperform.api.products.list({ form: 'eqadkzns' });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `form` | `string` | Yes | Form slug, custom slug or id (from forms.list). |
| `search` | `string` | No | Text to search for. |

`GET /v1/forms/{slug_or_id}/products`.

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `products` | `object[]` | Yes | — |

> [accordion] products full type
>
> ```ts theme={null}
> {
>   SKU?: string | null,
>   name?: string | null,
>   price?: number | string | null,
>   quantity?: number | string | null,
>   minimum?: number | string | null,
>   maximum?: number | string | null,
>   discountable?: boolean | null,
>   sold?: number | string | null
> }[]
> ```

***

### update

`products.update`

Change a product on a form (name, price, stock, min/max per order). Fields you leave out stay as they are.

**Risk:** `write`

```ts theme={null}
await corsair.paperform.api.products.update({ form: 'eqadkzns', sku: 'tshirt-small', quantity: 20 });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `form` | `string` | Yes | Form slug, custom slug or id (from forms.list). |
| `sku` | `string` | Yes | Product SKU. |
| `name` | `string` | No | — |
| `price` | `number` | No | — |
| `quantity` | `number \| null` | No | Stock left. null removes the limit. |
| `minimum` | `number \| null` | No | — |
| `maximum` | `number \| null` | No | — |
| `discountable` | `boolean` | No | — |

`PUT /v1/forms/{slug_or_id}/products/{sku}`. Business API.

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `product` | `object` | Yes | — |

> [accordion] product full type
>
> ```ts theme={null}
> {
>   SKU?: string | null,
>   name?: string | null,
>   price?: number | string | null,
>   quantity?: number | string | null,
>   minimum?: number | string | null,
>   maximum?: number | string | null,
>   discountable?: boolean | null,
>   sold?: number | string | null
> }
> ```

***

## Spaces

### forms

`spaces.forms`

List the forms in one space.

**Risk:** `read`

```ts theme={null}
await corsair.paperform.api.spaces.forms({ id: '10001131833' });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |

`GET /v1/spaces/{id}/forms`.

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `forms` | `object[]` | Yes | — |
| `page` | `object` | Yes | — |

> [accordion] forms full type
>
> ```ts theme={null}
> {
>   id: string,
>   slug?: string | null,
>   custom_slug?: string | null,
>   space_id?: string,
>   title?: string | null,
>   description?: string | null,
>   url?: string | null,
>   live?: boolean,
>   submission_count?: number,
>   created_at_utc?: string | null,
>   updated_at_utc?: string | null
> }[]
> ```

> [accordion] page full type
>
> ```ts theme={null}
> {
>   total?: number,
>   hasMore?: boolean,
>   limit?: number,
>   skip?: number
> }
> ```

***

### get

`spaces.get`

Get one space by id.

**Risk:** `read`

```ts theme={null}
await corsair.paperform.api.spaces.get({ id: '10001131833' });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |

`GET /v1/spaces/{id}`.

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `space` | `object` | Yes | — |

> [accordion] space full type
>
> ```ts theme={null}
> {
>   id: string,
>   name?: string | null,
>   created_at_utc?: string | null,
>   updated_at_utc?: string | null
> }
> ```

***

### list

`spaces.list`

List spaces (folders of forms).

**Risk:** `read`

```ts theme={null}
await corsair.paperform.api.spaces.list({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `search` | `string` | No | Text to search for. |
| `limit` | `number` | No | Results per page. Paperform defaults to 20. |
| `skip` | `number` | No | Results to skip. |
| `afterId` | `string` | No | Only results after this id. |
| `beforeId` | `string` | No | Only results before this id. |
| `afterDate` | `string` | No | Only results created after this date (YYYY-MM-DD or ISO). |
| `beforeDate` | `string` | No | Only results created before this date (YYYY-MM-DD or ISO). |
| `sort` | `ASC \| DESC` | No | Order by creation date. |

`GET /v1/spaces`.

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `spaces` | `object[]` | Yes | — |
| `page` | `object` | Yes | — |

> [accordion] spaces full type
>
> ```ts theme={null}
> {
>   id: string,
>   name?: string | null,
>   created_at_utc?: string | null,
>   updated_at_utc?: string | null
> }[]
> ```

> [accordion] page full type
>
> ```ts theme={null}
> {
>   total?: number,
>   hasMore?: boolean,
>   limit?: number,
>   skip?: number
> }
> ```

***

## Submissions

### delete

`submissions.delete`

Delete one submission. It cannot be recovered.

**Risk:** `destructive`

```ts theme={null}
await corsair.paperform.api.submissions.delete({ form: 'eqadkzns', id: '6afc3d806e698e3d810e785b' });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `form` | `string` | Yes | Form slug, custom slug or id (from forms.list). |
| `id` | `string` | Yes | Submission id. |

`DELETE /v1/forms/{slug_or_id}/submissions/{id}`. The local row goes only after Paperform confirms.

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `deleted` | `true` | Yes | — |

***

### get

`submissions.get`

Get one submission of a form, with its answers.

**Risk:** `read`

```ts theme={null}
await corsair.paperform.api.submissions.get({ form: 'eqadkzns', id: '6afc3d806e698e3d810e785b' });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `form` | `string` | Yes | Form slug, custom slug or id (from forms.list). |
| `id` | `string` | Yes | Submission id. |

`GET /v1/forms/{slug_or_id}/submissions/{id}`.

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `submission` | `object` | Yes | — |

> [accordion] submission full type
>
> ```ts theme={null}
> {
>   id: string,
>   form_id?: string | null,
>   data?: Record<string, any>,
>   device?: any,
>   charge?: any,
>   pdfs?: any,
>   created_at_utc?: string | null
> }
> ```

***

### list

`submissions.list`

List the completed submissions of a form, with their answers keyed by field key. Filter by date or id, page with limit and skip.

**Risk:** `read`

```ts theme={null}
await corsair.paperform.api.submissions.list({ form: 'eqadkzns', afterDate: '2026-11-01', sort: 'DESC' });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `form` | `string` | Yes | Form slug, custom slug or id (from forms.list). |
| `limit` | `number` | No | Results per page. Paperform defaults to 20. |
| `skip` | `number` | No | Results to skip. |
| `afterId` | `string` | No | Only results after this id. |
| `beforeId` | `string` | No | Only results before this id. |
| `afterDate` | `string` | No | Only results created after this date (YYYY-MM-DD or ISO). |
| `beforeDate` | `string` | No | Only results created before this date (YYYY-MM-DD or ISO). |
| `sort` | `ASC \| DESC` | No | Order by creation date. |

`GET /v1/forms/{slug_or_id}/submissions`. Stores id, form id and created date only.

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `submissions` | `object[]` | Yes | — |
| `page` | `object` | Yes | — |

> [accordion] submissions full type
>
> ```ts theme={null}
> {
>   id: string,
>   form_id?: string | null,
>   data?: Record<string, any>,
>   device?: any,
>   charge?: any,
>   pdfs?: any,
>   created_at_utc?: string | null
> }[]
> ```

> [accordion] page full type
>
> ```ts theme={null}
> {
>   total?: number,
>   hasMore?: boolean,
>   limit?: number,
>   skip?: number
> }
> ```

***

## Translations

### list

`translations.list`

List form translations (title and language). The mapping text is not stored.

**Risk:** `read`

```ts theme={null}
await corsair.paperform.api.translations.list({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `limit` | `number` | No | Results per page. Paperform defaults to 20. |
| `skip` | `number` | No | Results to skip. |
| `afterId` | `string` | No | Only results after this id. |
| `beforeId` | `string` | No | Only results before this id. |
| `afterDate` | `string` | No | Only results created after this date (YYYY-MM-DD or ISO). |
| `beforeDate` | `string` | No | Only results created before this date (YYYY-MM-DD or ISO). |
| `sort` | `ASC \| DESC` | No | Order by creation date. |

`GET /v1/translations`. Stores id, title and language; not the mapping.

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `translations` | `object[]` | Yes | — |
| `page` | `object` | Yes | — |

> [accordion] translations full type
>
> ```ts theme={null}
> {
>   id: string,
>   title?: string | null,
>   language?: string | null
> }[]
> ```

> [accordion] page full type
>
> ```ts theme={null}
> {
>   total?: number,
>   hasMore?: boolean,
>   limit?: number,
>   skip?: number
> }
> ```

***

## Webhooks

### create

`webhooks.create`

Add a webhook that posts each new submission (and optionally partial submission) of a form to an https URL.

**Risk:** `write`

```ts theme={null}
await corsair.paperform.api.webhooks.create({ form: 'eqadkzns', targetUrl: 'https://example.com/paperform', triggers: ['submission'] });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `form` | `string` | Yes | Form slug, custom slug or id (from forms.list). |
| `targetUrl` | `string` | Yes | HTTPS URL Paperform posts each submission to. |
| `triggers` | `(submission \| partial_submission)[]` | Yes | Events that fire the webhook. |

`POST /v1/forms/{slug_or_id}/webhooks`. Business API. The target URL stays out of events.

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `webhook` | `object` | Yes | — |

> [accordion] webhook full type
>
> ```ts theme={null}
> {
>   id: string,
>   target_url?: string | null,
>   triggers?: string[],
>   created_at_utc?: string | null
> }
> ```

***

### delete

`webhooks.delete`

Delete a webhook by id.

**Risk:** `destructive`

```ts theme={null}
await corsair.paperform.api.webhooks.delete({ id: '5d40fdaf174b4c0007043072' });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | Webhook id. |

`DELETE /v1/webhooks/{id}`. Business API.

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `deleted` | `true` | Yes | — |

***

### list

`webhooks.list`

List a form's webhooks.

**Risk:** `read`

```ts theme={null}
await corsair.paperform.api.webhooks.list({ form: 'eqadkzns' });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `form` | `string` | Yes | Form slug, custom slug or id (from forms.list). |
| `limit` | `number` | No | Results per page. Paperform defaults to 20. |
| `skip` | `number` | No | Results to skip. |
| `afterId` | `string` | No | Only results after this id. |
| `beforeId` | `string` | No | Only results before this id. |
| `afterDate` | `string` | No | Only results created after this date (YYYY-MM-DD or ISO). |
| `beforeDate` | `string` | No | Only results created before this date (YYYY-MM-DD or ISO). |
| `sort` | `ASC \| DESC` | No | Order by creation date. |

`GET /v1/forms/{slug_or_id}/webhooks`.

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `webhooks` | `object[]` | Yes | — |
| `page` | `object` | Yes | — |

> [accordion] webhooks full type
>
> ```ts theme={null}
> {
>   id: string,
>   target_url?: string | null,
>   triggers?: string[],
>   created_at_utc?: string | null
> }[]
> ```

> [accordion] page full type
>
> ```ts theme={null}
> {
>   total?: number,
>   hasMore?: boolean,
>   limit?: number,
>   skip?: number
> }
> ```

***


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