> For the complete documentation index, see [llms.txt](https://docs.simplio3d.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.simplio3d.com/api-reference/open-api/contact-form/forms.md).

# Forms

## <mark style="color:green;">GET</mark> /configurator-forms/

#### Simplio3D API: Fetch All Configurator Forms

**Endpoint**: `GET /api/v1/configurator-forms`

**Description**: This endpoint retrieves a list of all configurator forms available in the Simplio3D system.

**Request**

* **Method**: `GET`

* **URL Parameters**: None

* **Headers**:

  * `Authorization`: `Bearer <access_token>`

  **Response**

  * **Status Code**: `200 OK`
  * **Content-Type**: `application/json`

  **Response Body**:

  ```json
  [
    {
      "form_id": "123",
      "name": "Configurator Form 1",
      "description": "Description of configurator form 1",
      "created_at": "2023-01-01T12:00:00Z",
      "updated_at": "2023-01-02T12:00:00Z"
    },
    {
      "form_id": "124",
      "name": "Configurator Form 2",
      "description": "Description of configurator form 2",
      "created_at": "2023-01-03T12:00:00Z",
      "updated_at": "2023-01-04T12:00:00Z"
    }
  ]
  ```

* **Notes**
  * Ensure that the API token used in the request is valid and has the required permissions.
  * The response includes metadata about each configurator form, such as creation and last update timestamps.
  * Ensure you have the necessary authorization credentials (e.g., Bearer Token) to access this endpoint which is taken from the 'Share' tab encryption token found at the bottom of the page.

## Fetch all configurator forms

> Get a list of configurator forms.

```json
{"openapi":"3.0.0","info":{"title":"Simplio3D-Open REST API","version":"1.0.0"},"tags":[{"name":"Configurator Forms","description":"API Endpoints for managing configurator forms"}],"servers":[{"url":"https://app.simplio3d.com","description":"API Open Base URL"},{"url":""}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Enter token in format (Bearer <your_token>)"}},"schemas":{"ConfiguratorFormsResource":{"title":"Configurator Form Resource","description":"Configurator Form details","properties":{"id":{"type":"integer","format":"int64"},"configurator_id":{"type":"integer","format":"int64"},"enable_form":{"type":"boolean"},"created_at":{"type":"string","format":"date-time"}},"type":"object"}}},"paths":{"/api/open-api/v1/configurator-forms":{"get":{"tags":["Configurator Forms"],"summary":"Fetch all configurator forms","description":"Get a list of configurator forms.","operationId":"17d7fc714a3ac9e7c0b92e44131f0365","responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ConfiguratorFormsResource"}}}}},"401":{"description":"Unauthorized"},"500":{"description":"Internal Server Error"}}}}}}
```

## <mark style="color:green;">GET</mark> /configurator-forms/{id}

#### Fetch a Specific Configurator Form

**Endpoint**: `GET /api/v1/configurator-forms/{form_id}`

**Description**: This endpoint retrieves details of a specific configurator form by its ID in the Simplio3D system.

**Request**

* **Method**: `GET`
* **URL Parameters**: None

**NOTE:** Ensure you have the necessary authorization credentials (e.g., Bearer Token) to access this endpoint which is taken from the 'Share' tab encryption token found at the bottom of the page.

## Fetch a specific configurator form

> Get a specific configurator form by ID.

```json
{"openapi":"3.0.0","info":{"title":"Simplio3D-Open REST API","version":"1.0.0"},"tags":[{"name":"Configurator Forms","description":"API Endpoints for managing configurator forms"}],"servers":[{"url":"https://app.simplio3d.com","description":"API Open Base URL"},{"url":""}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Enter token in format (Bearer <your_token>)"}},"schemas":{"ConfiguratorFormsResource":{"title":"Configurator Form Resource","description":"Configurator Form details","properties":{"id":{"type":"integer","format":"int64"},"configurator_id":{"type":"integer","format":"int64"},"enable_form":{"type":"boolean"},"created_at":{"type":"string","format":"date-time"}},"type":"object"}}},"paths":{"/api/open-api/v1/configurator-forms/{id}":{"get":{"tags":["Configurator Forms"],"summary":"Fetch a specific configurator form","description":"Get a specific configurator form by ID.","operationId":"33ee5a0698eb236d16cc84d2db0647d8","parameters":[{"name":"id","in":"path","description":"ID of the configurator form","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfiguratorFormsResource"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Configurator Form not found"},"500":{"description":"Internal Server Error"}}}}}}
```

## The ConfiguratorFormsResource object

```json
{"openapi":"3.0.0","info":{"title":"Simplio3D-Open REST API","version":"1.0.0"},"components":{"schemas":{"ConfiguratorFormsResource":{"title":"Configurator Form Resource","description":"Configurator Form details","properties":{"id":{"type":"integer","format":"int64"},"configurator_id":{"type":"integer","format":"int64"},"enable_form":{"type":"boolean"},"created_at":{"type":"string","format":"date-time"}},"type":"object"}}}}
```