---
title: "List website request forms"
url: https://docs.light-ai.app/api-reference/website-forms/list-forms.md
canonical_url: https://docs.light-ai.app/api-reference/website-forms/list-forms
last_updated: 2026-10-13
summary: "GET /v1/forms: Newest first."
api_status: beta
related:
  - https://docs.light-ai.app/api-reference/website-forms
---

# List website request forms

> GET /v1/forms: Newest first.

`GET /v1/forms`

Newest first. Website request forms are live configuration: test keys always get an empty list.

|   |   |
| --- | --- |
| Scope | `forms:read` |
| Credential | API key: `Authorization: Bearer lai_live_…` (or `lai_test_…`). Partner keys add `Light-AI-Organization`. |
| Test mode | Works with test keys against simulated test objects. |

## Query parameters

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `limit` | integer |  | Page size, 1–100 (default 25). 1–100. |
| `cursor` | string |  | next_cursor from the previous page. At most 400 characters. |
| `status` | string |  | One of: `active`, `paused`, `archived`. |

## Headers

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `Light-AI-Organization` | string |  | Partner keys: the connected organization to act for (`org_…`). Organization keys may omit it. Id prefix `org_`. |
| `Light-AI-Version` | string |  | Pin a dated API version (defaults to the key's version). One of: `2026-11-01`. |

## Response 200

A page of forms.

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `object` | string | yes | Always `list`. |
| `data` | object[] | yes |  |
| `data[].id` | string | yes | Id prefix `form_`. |
| `data[].object` | string | yes | Always `form`. |
| `data[].name` | string | yes |  |
| `data[].status` | string | yes | One of: `active`, `paused`, `archived`. |
| `data[].service_type` | string | yes | One of: `christmas_lights`, `custom`. |
| `data[].public_id` | string | yes | The id in the install snippet (`ec_…`). |
| `data[].install` | object | yes |  |
| `data[].install.script` | string | yes | The snippet to paste on the website. |
| `data[].install.iframe_url` | string | yes |  |
| `data[].install.hosted_url` | string \| null | yes | Top-level page link (null unless the hosted page is on). |
| `data[].domains` | string[] | yes | Websites allowed to show the form (origins; `https://*.example.com` wildcards). |
| `data[].hosted_page_enabled` | boolean | yes |  |
| `data[].fields` | object | yes |  |
| `data[].photo` | object | yes |  |
| `data[].consent` | object | yes |  |
| `data[].questions` | object[] | yes | In the order the form asks them (the owner can drag questions in the editor; follow-ups always come right after their parent question). The fixed address & photo card follows `surfaces` and `primary_color`, then contact details; the request is sent from the last question. |
| `data[].questions[].key` | string | yes |  |
| `data[].questions[].prompt` | string | yes |  |
| `data[].questions[].type` | string | yes | One of: `color`, `choice`, `multi_choice`, `toggle`, `text`. |
| `data[].questions[].enabled` | boolean | yes |  |
| `data[].questions[].required` | boolean | yes |  |
| `data[].questions[].choices` | object[] | yes |  |
| `data[].mockup_reveal` | object |  | How the request's AI mockup appears on the form (it starts on the homeowner's photo): `slider` (default, a draggable before/after divider), `flicker`, `day_night`, `bloom`, `sweep` or `curtain`; `slider_after` hands the five other styles over to the slider when they end. The form's own choice, else the company default. Set in the app. |
| `data[].mockup_reveal.style` | string | yes | One of: `slider`, `flicker`, `day_night`, `bloom`, `sweep`, `curtain`. |
| `data[].mockup_reveal.slider_after` | boolean | yes |  |
| `data[].copy` | object | yes |  |
| `data[].copy.heading` | string \| null | yes |  |
| `data[].copy.subheading` | string \| null | yes |  |
| `data[].copy.button_label` | string \| null | yes |  |
| `data[].copy.success_message` | string \| null | yes |  |
| `data[].instant_preview` | object | yes |  |
| `data[].instant_preview.enabled` | boolean | yes |  |
| `data[].instant_preview.images_per_lead` | integer | yes | AI mockup previews per request: always 1 (one AI mockup per request since October 2026). Kept for compatibility: PATCH still accepts 1 or 2 and stores 1. |
| `data[].instant_preview.credits_per_image` | integer | yes | Always 5. |
| `data[].instant_preview.monthly_credit_cap` | integer \| null | yes |  |
| `data[].instant_preview.used_this_month` | integer | yes | Credits used or held by previews this UTC month. |
| `data[].created_at` | timestamp | yes | RFC 3339 timestamp (UTC, milliseconds). |
| `data[].updated_at` | timestamp | yes | RFC 3339 timestamp (UTC, milliseconds). |
| `has_more` | boolean | yes |  |
| `next_cursor` | string \| null | yes | Pass as `cursor` to fetch the next page. |

## Errors

| Status | Meaning |
| --- | --- |
| `400` | Bad request. [`bad_request`](https://docs.light-ai.app/errors#bad_request), [`test_mode_mismatch`](https://docs.light-ai.app/errors#test_mode_mismatch), [`test_mode_unsupported`](https://docs.light-ai.app/errors#test_mode_unsupported), [`unsupported_api_version`](https://docs.light-ai.app/errors#unsupported_api_version) |
| `401` | Missing or invalid credential. [`authentication_required`](https://docs.light-ai.app/errors#authentication_required), [`invalid_api_key`](https://docs.light-ai.app/errors#invalid_api_key), [`api_key_revoked`](https://docs.light-ai.app/errors#api_key_revoked), [`api_key_expired`](https://docs.light-ai.app/errors#api_key_expired), [`api_key_suspended`](https://docs.light-ai.app/errors#api_key_suspended) |
| `403` | Not allowed. [`insufficient_scope`](https://docs.light-ai.app/errors#insufficient_scope), [`plan_upgrade_required`](https://docs.light-ai.app/errors#plan_upgrade_required), [`organization_paused`](https://docs.light-ai.app/errors#organization_paused), [`organization_off_season`](https://docs.light-ai.app/errors#organization_off_season), [`api_disabled`](https://docs.light-ai.app/errors#api_disabled), [`api_access_not_enabled`](https://docs.light-ai.app/errors#api_access_not_enabled), [`ip_not_allowed`](https://docs.light-ai.app/errors#ip_not_allowed), [`forbidden`](https://docs.light-ai.app/errors#forbidden) |
| `404` | Not found (also for objects of other organizations and for organizations without an active grant). |
| `422` | Validation failed. [`idempotency_key_reused`](https://docs.light-ai.app/errors#idempotency_key_reused) |
| `429` | Rate limited or daily cap reached. See Retry-After and the RateLimit headers. [`rate_limited`](https://docs.light-ai.app/errors#rate_limited), [`daily_cap_reached`](https://docs.light-ai.app/errors#daily_cap_reached) |
| `500` | Unexpected server error. Safe to retry with exponential backoff; quote the Request-Id to support. [`internal_error`](https://docs.light-ai.app/errors#internal_error) |
| `503` | Temporarily unavailable. Retry with exponential backoff. [`service_unavailable`](https://docs.light-ai.app/errors#service_unavailable) |

## Examples

**Request**

curl:

```bash
curl -X GET "https://api.light-ai.app/v1/forms" \
  -H "Authorization: Bearer $LIGHT_AI_API_KEY"
```

JavaScript:

```javascript
const response = await fetch('https://api.light-ai.app/v1/forms', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.LIGHT_AI_API_KEY}`,
  },
});
const data = await response.json();
```

Python:

```python
import os, uuid, requests

response = requests.get(
    "https://api.light-ai.app/v1/forms",
    headers={
        "Authorization": f"Bearer {os.environ['LIGHT_AI_API_KEY']}",
    },
    timeout=30,
)
data = response.json()
```

**Response 200**

```json
{
  "object": "list",
  "data": [
    {
      "id": "form_3f9c2a7be41d…",
      "object": "form",
      "name": "Dana Reyes",
      "status": "active",
      "service_type": "christmas_lights",
      "public_id": "string",
      "install": {
        "script": "string",
        "iframe_url": "https://example.com/…",
        "hosted_url": "https://example.com/…"
      },
      "domains": [
        "string"
      ],
      "hosted_page_enabled": true,
      "fields": {},
      "photo": {},
      "consent": {},
      "questions": [
        {
          "key": "string",
          "prompt": "string",
          "type": "color",
          "enabled": true,
          "required": true,
          "choices": []
        }
      ],
      "mockup_reveal": {
        "style": "slider",
        "slider_after": true
      },
      "copy": {
        "heading": "string",
        "subheading": "string",
        "button_label": "string",
        "success_message": "string"
      },
      "instant_preview": {
        "enabled": true,
        "images_per_lead": 1,
        "credits_per_image": 0,
        "monthly_credit_cap": 0,
        "used_this_month": 0
      },
      "created_at": "2026-10-12T14:03:11.000Z",
      "updated_at": "2026-10-12T14:03:11.000Z"
    }
  ],
  "has_more": true,
  "next_cursor": "string"
}
```