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:
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
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.
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
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
Example Response
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.
Last updated
Was this helpful?