Simplio3D
HomeHelp Center
  • INTRODUCTION
  • GETTING STARTED
    • Create an account
    • Prepare 3D models
  • LEARNING THE APP
    • Dashboard
    • My Account
    • Products
      • New Product
      • Select Layout
      • Add 3D Models
        • 3D Model versions
      • Create Options
        • Default
        • Sections
        • Dropdown
        • Material
        • Checkbox
        • Toggle
        • Thumbnails
        • Arrows
        • Upload
        • Text
        • Numeral
          • Sizing: Keep the proportions
        • Restrictions
          • 'Has one or more variants selected from' type of restriction
          • 'The variant value is between min and max' type of restriction
      • Pricing
        • Pricing formula
        • Variables
        • Add price
      • Add form
        • Add Field
        • Email Settings
          • Gmail
          • Sendgrid
      • Share
      • Product Viewer
    • Materials
      • New Materials
      • Textures
      • Categories
    • 3D Assets
      • Edit 3D Assets
      • Categories
      • File too large
    • Orders
  • Integrations
    • API Documentation
  • API Reference
    • Partner API
      • Managing Orders
    • Open API
      • Getting Started
      • User Authentication
      • 3D Assets
      • Configurators
      • Contact Form
        • Form Fields
        • Forms
      • Options
        • Options
        • Option Variations
        • Option Restrictions
      • Price Groups
      • Share
      • Materials
        • Materials
        • Material Categories
      • Textures
        • Textures
        • Texture Categories
      • Orders
  • Other
    • Change Log
Powered by GitBook
On this page

Was this helpful?

  1. API Reference
  2. Open API

Configurators

Retrieve detailed information about a specific configurator

GET /configurator/{id}

Endpoint

GET /open-api/v1/configurator/{id}

Description

Retrieve detailed information about a specific configurator identified by the unique id.

Parameters

  • id (required): A unique identifier for the configurator you want to retrieve.

Request Example

GET /api/configurators/12345 HTTP/1.1
Host: api.simplio3d.com
Authorization: Bearer {access_token}
Accept: application/json

Response

  • 200 OK: The request was successful, and the configurator details are returned.

  • 404 Not Found: No configurator was found with the specified id.

Response Example

{
  "id": "12345",
  "name": "3D Configurator",
  "description": "A sample 3D product configurator",
  "created_at": "2023-05-12T14:30:00Z"
}

Error Handling

  • Ensure the id provided is correct and exists.

  • Verify authentication token is valid and has adequate permissions.

Notes

  • Make sure to replace {id} with the actual configurator ID you need.

  • Ensure you have the necessary authorization credentials (e.g., Bearer Token) to access this endpoint.

Previous3D AssetsNextContact Form

Last updated 10 days ago

Was this helpful?

Get configurator by ID

get

Get a specific configurator by ID.

Authorizations
Responses
200
Successful response
application/json
401
Unauthorized
404
Configurator not found
500
Internal Server Error
get
GET /api/open-api/v1/configurator/show HTTP/1.1
Host: app.simplio3d.com
Authorization: Bearer JWT
Accept: */*
{
  "id": 1,
  "name": "3D Product Configurator",
  "configurator_type": "Advanced",
  "configurator_template": "Default Template",
  "configurator_integration": "Shopify",
  "created_at": "2024-02-25T12:00:00Z",
  "updated_at": "2024-02-25T12:30:00Z",
  "created_by": "John Doe"
}
  • GET /configurator/{id}
  • GETGet configurator by ID