# Share
## GET /configurator-share
### Simplio3D API: Get List of Configurator Shares
#### Endpoint
* **HTTP Method**: `GET`
* **URL**: `/open-api/v1/configurator-share`
#### Description
This endpoint retrieves a list of all configurator shares available to the authenticated user.
#### Request Headers
* `Authorization`: Bearer token for authenticating the API request.
#### Response
* **Status Code**: `200 OK`
* **Response Body**:
* An array of configurator share objects. Each object contains:
* `id`: Unique identifier for the configurator share.
* `name`: Name of the configurator.
* `created_at`: Timestamp of when the share was created.
* `updated_at`: Timestamp of the last update.
#### Example
**Request**
```
GET /open-api/v1/configurator-share
Authorization: Bearer
```
**Successful Response**
```json
[
{
"id": "12345",
"name": "Configurator Name",
"created_at": "2023-05-01T12:00:00Z",
"updated_at": "2023-06-01T12:00:00Z"
},
...
]
```
**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 list of configurator shares
> Get all configurator shares.
```json
{"openapi":"3.0.0","info":{"title":"Simplio3D-Open REST API","version":"1.0.0"},"tags":[{"name":"Configurator Shares","description":"API Endpoints for managing configurator share"}],"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 )"}},"schemas":{"ConfiguratorShareResource":{"title":"Configurator Share Resource","description":"Schema for configurator share","properties":{"id":{"type":"integer"},"configurator_id":{"type":"integer"},"share_url":{"type":"string"},"enable_sidebar":{"type":"boolean"},"enable_ar":{"type":"boolean"},"dark_theme":{"type":"boolean"},"show_dimensions":{"type":"boolean"},"domain_name":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"type":"object"}}},"paths":{"/api/open-api/v1/configurator-share":{"get":{"tags":["Configurator Shares"],"summary":"Get list of configurator shares","description":"Get all configurator shares.","operationId":"5c832085a3eedd58b0d87b1a6e207e64","responses":{"200":{"description":"List of configurator shares retrieved successfully","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ConfiguratorShareResource"}}}}},"401":{"description":"Unauthorized"},"500":{"description":"Internal Server Error"}}}}}}
```
## GET /configurator-share/{id}
#### Get Configurator Share by ID
The Simplio3D API provides a straightforward method to fetch the details of a specific configurator share using its unique identifier. This endpoint is beneficial when you need information on a particular configurator share without retrieving the entire list.
**Endpoint Overview**
**HTTP Method**: `GET`\
**Endpoint**: `/open-api/v1/configurator-share/{id}`
**Headers**
* `Authorization`: Bearer token for authenticating the API request. Ensure that the token has the necessary permissions to access the configurator share data.
**Parameters**
* `id`: The unique identifier of the configurator share you wish to retrieve. This is a path parameter and is required to access the specific share.
**Example Request**
Here's how you can make a request to fetch a configurator share by its ID:
```
GET /open-api/v1/configurator-share/12345
Authorization: Bearer
```
**Response**
Upon successful retrieval, the API will respond with the following:
* **Status Code**: `200 OK`
* **Unauthorized:** 401
* **Configurator share not found:** 404
* **Internal server error:** 500
**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 share by ID
> Get a specific configurator share by ID.
```json
{"openapi":"3.0.0","info":{"title":"Simplio3D-Open REST API","version":"1.0.0"},"tags":[{"name":"Configurator Shares","description":"API Endpoints for managing configurator share"}],"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 )"}},"schemas":{"ConfiguratorShareResource":{"title":"Configurator Share Resource","description":"Schema for configurator share","properties":{"id":{"type":"integer"},"configurator_id":{"type":"integer"},"share_url":{"type":"string"},"enable_sidebar":{"type":"boolean"},"enable_ar":{"type":"boolean"},"dark_theme":{"type":"boolean"},"show_dimensions":{"type":"boolean"},"domain_name":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"type":"object"}}},"paths":{"/api/open-api/v1/configurator-share/{id}":{"get":{"tags":["Configurator Shares"],"summary":"Get configurator share by ID","description":"Get a specific configurator share by ID.","operationId":"a2bf0be7592becb317bda462242059d7","parameters":[{"name":"id","in":"path","description":"ID of the configurator share","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Configurator share retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfiguratorShareResource"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Configurator share not found"},"500":{"description":"Internal Server Error"}}}}}}
```
## The ConfiguratorShareResource object
```json
{"openapi":"3.0.0","info":{"title":"Simplio3D-Open REST API","version":"1.0.0"},"components":{"schemas":{"ConfiguratorShareResource":{"title":"Configurator Share Resource","description":"Schema for configurator share","properties":{"id":{"type":"integer"},"configurator_id":{"type":"integer"},"share_url":{"type":"string"},"enable_sidebar":{"type":"boolean"},"enable_ar":{"type":"boolean"},"dark_theme":{"type":"boolean"},"show_dimensions":{"type":"boolean"},"domain_name":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"type":"object"}}}}
```
---
# Agent Instructions: Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://docs.simplio3d.com/api-reference/open-api/share.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.