Form Fields

Get a list of configurator form fields.

GET /configurator-form-fields

Fetch All Configurator Form Fields

To retrieve all configurator form fields in Simplio3D, use the following GET API endpoint:

GET /open-api/v1/configurator-form-fields

Parameters

• configurator_id (required): The unique identifier for the configurator.

Response

A successful response returns a JSON object containing:

• id: The field ID.

• name: The field name.

• type: The field type (e.g., first name, last name, email, phone, text, select).

• options: Available options for select-type fields (if applicable).

• default: The default value for the field.

• required: Boolean indicating if the field is mandatory.

Example

{
  "fields": [
    {
      "id": "123",
      "name": "Shipping",
      "type": "Dropdown",
      "options": ["UPS", "FedEx", "No shipping"],
      "default": "Red",
      "required": true
    },
    {
      "id": "124",
      "name": "Size",
      "type": "text",
      "default": "Medium",
      "required": false
    }
  ]
}

Use this endpoint to programmatically fetch and manage form fields for configurators in your application.

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 all configurator form fields

get

Get a list of configurator form fields.

Authorizations

Query parameters

order_bystringOptional

Column to order results by (e.g., 'created_at')

Example: created_at

orderstring · enumOptional

Sorting order (asc or desc)

Example: descPossible values:

per_pageintegerOptional

Number of records per page (-1 for all records)

Example: 25

pageintegerOptional

Number of page

Example: 2

Responses

200

Successful response

application/json

401

Unauthorized

500

Internal Server Error

get

HTTPcURLJavaScriptPython

GET /api/open-api/v1/configurator-form-fields HTTP/1.1
Host: app.simplio3d.com
Authorization: Bearer JWT
Accept: */*

[
  {
    "id": 12,
    "configurator_id": 127,
    "title": "Customer Name",
    "type": "form_text",
    "mandatory_status": "required",
    "description": "Name of the customer",
    "settings": "{}",
    "show_title": 1,
    "created_at": "2024-02-25T12:00:00Z",
    "updated_at": "2024-02-25T12:30:00Z"
  }
]

GET /configurator/form-fields

Simplio3D API: Get Configurator Form Field by ID

The GET endpoint allows you to retrieve details about a specific form field used in configurators by providing the field's ID. This is useful for applications needing to dynamically access, display, or modify form fields based on current configuration requirements.

Endpoint

GET /api/configurator/form-fields/{fieldId}

Parameters

• fieldId (string): The unique identifier of the form field you want to retrieve.

Response

The response will contain the details of the form field, including:

• id: The ID of the form field.

• name: The name of the form field.

• type: The type of the form field (e.g., Dropdown, Text).

• options: An array of options available for Dropdown types.

• default: The default value for the form field.

• required: A boolean indicating if the field is required.

Example Request

GET /api/configurator/form-fields/123

Example Response

{
  "id": "123",
  "name": "Shipping",
  "type": "Dropdown",
  "options": ["UPS", "FedEx", "No shipping"],
  "default": "UPS",
  "required": true
}

This endpoint is essential for managing and displaying dynamic form fields within your application, ensuring you have up-to-date configurations.

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.

Get configurator form field by ID

get

Get a specific configurator form field by ID.

Authorizations

Path parameters

idinteger · int64Required

ID of the configurator form field

Example: 12

Responses

200

Successful response

application/json

401

Unauthorized

404

Configurator form field not found

500

Server error

get

HTTPcURLJavaScriptPython

GET /api/open-api/v1/configurator-form-fields/{id} HTTP/1.1
Host: app.simplio3d.com
Authorization: Bearer JWT
Accept: */*

{
  "id": 12,
  "configurator_id": 127,
  "title": "Customer Name",
  "type": "form_text",
  "mandatory_status": "required",
  "description": "Name of the customer",
  "settings": "{}",
  "show_title": 1,
  "created_at": "2024-02-25T12:00:00Z",
  "updated_at": "2024-02-25T12:30:00Z"
}