# Bigcommerce\StorefrontFormFields\FormFieldsApi

All URIs are relative to https://your_store.example.com/api/storefront, except if the operation defines another base path.

| Method | HTTP request | Description |
| ------------- | ------------- | ------------- |
| [**getFormFields()**](FormFieldsApi.md#getFormFields) | **GET** /form-fields | Get Form Fields |


## `getFormFields()`

```php
getFormFields($filter): \Bigcommerce\StorefrontFormFields\Model\FormFieldGroups
```

Get Form Fields

Gets form fields.  > #### Note > * Substitute your storefront domain for `yourstore.example.com`.  > * The Send a Test Request feature is not currently supported for this endpoint.

### Example

```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new Bigcommerce\StorefrontFormFields\Api\FormFieldsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$filter = 'filter_example'; // string

try {
    $result = $apiInstance->getFormFields($filter);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FormFieldsApi->getFormFields: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

| Name | Type | Description  | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **filter** | **string**|  | [optional] |

### Return type

[**\Bigcommerce\StorefrontFormFields\Model\FormFieldGroups**](../Model/FormFieldGroups.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: `application/json`

[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)
