> To build or manage a Wix site with an AI agent, follow https://www.wix.com/headless/skill.md
> It builds a new Wix site or puts your own site online, from a prompt, and keeps changing it afterwards. The pages are code in any web technology, and Wix runs the backend.
> It works through the Wix plugin (the Wix MCP and the Wix skills), the Wix CLI or no Wix login, and puts the site live on Wix hosting or on another host.
> Business features include a store, bookings, events and tickets, a restaurant, a blog, forms, members and many more.
> Read the Wix skills online at https://www.wix.com/skills
> 
> Portal Navigation:
> 
> - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version.
> - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages).
> - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`).
> - If a reference page seems to be missing its schema (parameters, return types, or type definitions), append `?schema=true` to its `.md` URL (e.g. `https://dev.wix.com/docs/contexts/contexts/stores/category-info/use-category-info-context.md?schema=true`).
> - Top-level index of all portals: https://dev.wix.com/docs/llms.txt
> - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt

# getFormSummary

# Package: @wix/forms

# Namespace: forms

# Method link: https://dev.wix.com/docs/api-reference/crm/forms/form-schemas/get-form-summary.md

## Permission Scopes:
View Forms: SCOPE.FORMS.VIEW-FORM

## Introduction

Retrieves a summary of a form schema containing information about its fields.

Use this method to get an overview of a form schema without all the detailed configuration information.

---

## JavaScript SDK

### Schema

```
 Method: wixClientAdmin.forms.forms.getFormSummary(formId)
 Description: Retrieves a summary of a form schema containing information about its fields.  Use this method to get an overview of a form schema without all the detailed configuration information.
 # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present.
 Required parameters:  formId
 Method parameters: 
   param name: formId | type: string | description: GUID of the form schema to retrieve the summary for. | required: true | validation: format GUID
 Return type: PROMISE<GetFormSummaryResponse>
  - name: formSummary | type: FormSummary | description: The retrieved form schema summary.  
     - name: _id | type: string | description: Form schema GUID.  | validation: format GUID
     - name: fields | type: array<Field> | description: Simplified representation of form fields for quick overview and processing. Contains essential field information without complex validation or layout details.  | validation: maxItems 500
        - name: target | type: string | description: Human readable identifier used to reference a field.  | validation: maxLength 200, immutable
        - name: label | type: string | description: Display label shown to users for this field.  | validation: maxLength 350
        - name: type | type: InputType | description: Data type that this field accepts and validates.  
             - enum:
             -     UNKNOWN_INPUT_TYPE: Unknown input type.
             -     STRING: String input.
             -     NUMBER: Numeric input.
             -     RATING: Rating input.
             -     BOOLEAN: Boolean input.
             -     ARRAY: Array input.
             -     OBJECT: Object input.
             -     WIX_FILE: File upload input.
             -     SIGNATURE: Digital signature input.
             -     PAYMENT: Payment input.
             -     MULTILINE_ADDRESS: Multi-line address input.
             -     DATE: Date input.
             -     TIME: Time input.
             -     DATE_TIME: Combined date and time input.
             -     EMAIL: Email input.
             -     URL: URL input.
             -     UUID: UUID input.
             -     PHONE: Phone number input.
             -     URI: URI input.
             -     HOSTNAME: Hostname input.
             -     COLOR_HEX: Color input.
             -     CURRENCY: Currency input.
             -     LANGUAGE: Language input.
             -     DATE_OPTIONAL_TIME: Date input with optional time component.
             -     OBJECT_ARRAY: Array of object inputs, e.g. a repeater field with nested sub-fields.
        - name: options | type: array<Option> | description: Available options for fields that allow selection from predefined choices.  | validation: maxItems 1100
           - name: label | type: string | description: Display text shown to users for this option.  | validation: maxLength 400
           - name: value | type: string | description: Value associated with this option.  | validation: maxLength 400
        - name: deleted | type: boolean | description: Whether this field has been soft deleted from the form schema and placed in the trash bin.  
        - name: _id | type: string | description: Field GUID.  | validation: format GUID
        - name: fields | type: array<Field> | description: Nested fields for object-array (repeater) inputs. Empty for all other input types.  | validation: maxItems 50


```

### Examples

### getFormSummary
```javascript
import { forms } from '@wix/forms';

async function getFormSummary(formId) {
  const response = await forms.getFormSummary(formId);
};
```

### getFormSummary (with elevated permissions)
```javascript
import { forms } from '@wix/forms';
import { auth } from '@wix/essentials';

async function myGetFormSummaryMethod(formId) {
  const elevatedGetFormSummary = auth.elevate(forms.getFormSummary);
  const response = await elevatedGetFormSummary(formId);
}
```

### getFormSummary (self-managed)
Self-managed SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md).

```javascript
import { createClient } from '@wix/sdk';
import { forms } from '@wix/forms';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { forms },
  // Include the auth strategy and host as relevant
});


async function getFormSummary(formId) {
  const response = await myWixClient.forms.getFormSummary(formId);
};
```

---