> 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`).
> - 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: forms

# Namespace: FormSchemaService

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

## Permission Scopes:
Manage Submissions: SCOPE.DC-FORMS.MANAGE-SUBMISSIONS

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

---

## REST API

### Schema

```
 Method: getFormSummary
 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.
 URL: https://www.wixapis.com/v4/forms/{formId}/summary
 Method: GET
 # 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:   none | required: true
 Return type: GetFormSummaryResponse
  - name: formSummary | type: FormSummary | description: The retrieved form schema summary. 
     - name: id | type: string | description: Form schema 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. 
        - name: target | type: string | description: Human readable identifier used to reference a field. 
        - name: label | type: string | description: Display label shown to users for this field. 
        - 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.
        - name: options | type: array<Option> | description: Available options for fields that allow selection from predefined choices. 
           - name: label | type: string | description: Display text shown to users for this option. 
           - name: value | type: string | description: Value associated with this option. 
        - 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. 


```

### Examples

### Get Form Summary
Gets a summary of form by id returning forms' fields labels and ids in the order of layout

```curl
curl -X GET \
  'https://www.wixapis.com/form-schema-service/v4/forms/51564e13-e980-41f2-8525-eadb6e72a9bc/summary' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: <AUTH>'
```

---

## JavaScript SDK

### Schema

```
 Method: wixClientAdmin.forms.FormSchemaService.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
 Return type: PROMISE<GetFormSummaryResponse>
  - name: formSummary | type: FormSummary | description: The retrieved form schema summary. 
     - name: _id | type: string | description: Form schema 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. 
        - name: target | type: string | description: Human readable identifier used to reference a field. 
        - name: label | type: string | description: Display label shown to users for this field. 
        - 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.
        - name: options | type: array<Option> | description: Available options for fields that allow selection from predefined choices. 
           - name: label | type: string | description: Display text shown to users for this option. 
           - name: value | type: string | description: Value associated with this option. 
        - 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. 


```

### 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-hosted)
Self-hosted 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);
};
```

---