@magnetcustomer/sdk 1.0.0

package/docs/ConfigurationApi.md

@@ -0,0 +1,851 @@
+# ConfigurationApi
+
+All URIs are relative to *https://magnetcustomer.net/realms/platform/protocol/openid-connect*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**apiCustomfieldblocks507f1f77bcf86cd799439152Get**](#apicustomfieldblocks507f1f77bcf86cd799439152get) | **GET** /api/customfieldblocks/507f1f77bcf86cd799439152 | Get Custom Field Block|
+|[**apiCustomfieldblocksGet**](#apicustomfieldblocksget) | **GET** /api/customfieldblocks | List Custom Field Blocks|
+|[**apiCustomfields507f1f77bcf86cd799439150Get**](#apicustomfields507f1f77bcf86cd799439150get) | **GET** /api/customfields/507f1f77bcf86cd799439150 | Get Custom Field|
+|[**apiCustomfields507f1f77bcf86cd799439150Put**](#apicustomfields507f1f77bcf86cd799439150put) | **PUT** /api/customfields/507f1f77bcf86cd799439150 | Update Custom Field|
+|[**apiCustomfieldsPost**](#apicustomfieldspost) | **POST** /api/customfields | Create Custom Field|
+|[**apiCustomfieldtypesGet**](#apicustomfieldtypesget) | **GET** /api/customfieldtypes | List Custom Field Types|
+|[**apiDealsLabels507f1f77bcf86cd799439160Delete**](#apidealslabels507f1f77bcf86cd799439160delete) | **DELETE** /api/deals/labels/507f1f77bcf86cd799439160 | Delete Deal Label|
+|[**apiDealsLabels507f1f77bcf86cd799439160Put**](#apidealslabels507f1f77bcf86cd799439160put) | **PUT** /api/deals/labels/507f1f77bcf86cd799439160 | Update Deal Label|
+|[**apiDealsLabelsGet**](#apidealslabelsget) | **GET** /api/deals/labels | List Deal Labels|
+|[**apiDealsLabelsPost**](#apidealslabelspost) | **POST** /api/deals/labels | Create Deal Label|
+|[**apiRolesGet**](#apirolesget) | **GET** /api/roles | List Roles|
+|[**apiStaffs507f1f77bcf86cd799439180Get**](#apistaffs507f1f77bcf86cd799439180get) | **GET** /api/staffs/507f1f77bcf86cd799439180 | Get Staff|
+|[**apiStaffsGet**](#apistaffsget) | **GET** /api/staffs | List Staffs|
+|[**apiTeams507f1f77bcf86cd799439190Get**](#apiteams507f1f77bcf86cd799439190get) | **GET** /api/teams/507f1f77bcf86cd799439190 | Get Team|
+|[**apiTeamsGet**](#apiteamsget) | **GET** /api/teams | List Teams|
+|[**apiWorkspaces507f1f77bcf86cd799439170Get**](#apiworkspaces507f1f77bcf86cd799439170get) | **GET** /api/workspaces/507f1f77bcf86cd799439170 | Get Workspace|
+|[**apiWorkspaces507f1f77bcf86cd799439170Put**](#apiworkspaces507f1f77bcf86cd799439170put) | **PUT** /api/workspaces/507f1f77bcf86cd799439170 | Update Workspace|
+|[**apiWorkspacesGet**](#apiworkspacesget) | **GET** /api/workspaces | List Workspaces|
+|[**apiWorkspacesPost**](#apiworkspacespost) | **POST** /api/workspaces | Create Workspace|
+
+# **apiCustomfieldblocks507f1f77bcf86cd799439152Get**
+> apiCustomfieldblocks507f1f77bcf86cd799439152Get()
+
+Retrieves details of a specific custom field block by its ID.  Custom field blocks are named sections that organize custom fields in the UI sidebar. Each block has a position and can be shown on the right or left sidebar panel.  ## Response  Returns the custom field block object with: - `_id` (string): Block ID - `name` (string): Display name - `position` (number): Display order position - `isExpanded` (boolean): Whether expanded by default - `feature` (string): Entity type (`contact`, `deal`, etc.) - `sidebarPosition` (string): `right` or `left` - `active` (boolean): Whether active - `default` (boolean): Whether a system default block - `slug` (string): URL-friendly identifier - `createdAt` / `updatedAt` (string): ISO 8601 timestamps
+
+### Example
+
+```typescript
+import {
+    ConfigurationApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ConfigurationApi(configuration);
+
+const { status, data } = await apiInstance.apiCustomfieldblocks507f1f77bcf86cd799439152Get();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **apiCustomfieldblocksGet**
+> apiCustomfieldblocksGet()
+
+Lista blocos de agrupamento de campos customizados.
+
+### Example
+
+```typescript
+import {
+    ConfigurationApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ConfigurationApi(configuration);
+
+const { status, data } = await apiInstance.apiCustomfieldblocksGet();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **apiCustomfields507f1f77bcf86cd799439150Get**
+> ApiCustomfields507f1f77bcf86cd799439150Get200Response apiCustomfields507f1f77bcf86cd799439150Get()
+
+Retrieves details of a specific custom field by its ID.  ## Response  The response includes the full custom field object with the following fields:  - `_id` (string): Custom field ID - `system` (boolean): Whether this is a system-managed field - `feature` (string): The entity type this field belongs to (`contact`, `prospect`, `lead`, `deal`) - `name` (string): Display name of the custom field - `fieldType` (object): The field type definition with `fieldType` (e.g., `enum`, `text`, `number`, `date`) and display metadata - `values` (array): Predefined values (used for `enum` type fields), each with `value` and `_id` - `settings` (object): Visibility, editability and behavior rules per lifecycle stage - `position` (number): Display order position - `active` (boolean): Whether the field is active - `subFieldSettings` (object): Configuration for sub-fields - `dependentFields` (array): Fields that depend on this one - `customFieldBlockAttach` (object): The block/section this field is grouped into - `modules` (array): Modules where the field appears (e.g., `rule`, `dashboard`, `report`, `form`) - `slug` (string): URL-friendly identifier - `createdAt` / `updatedAt` (string): ISO 8601 timestamps
+
+### Example
+
+```typescript
+import {
+    ConfigurationApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ConfigurationApi(configuration);
+
+const { status, data } = await apiInstance.apiCustomfields507f1f77bcf86cd799439150Get();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**ApiCustomfields507f1f77bcf86cd799439150Get200Response**
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Get Custom Field |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **apiCustomfields507f1f77bcf86cd799439150Put**
+> apiCustomfields507f1f77bcf86cd799439150Put()
+
+Updates an existing custom field. All fields are optional: `name` (string), `values` (array of `{ \"value\": \"...\" }` objects for select/multi-select types), `settings` object (controls visibility and editability), `active` boolean, `position` number, `modules` array. Returns the updated custom field object.
+
+### Example
+
+```typescript
+import {
+    ConfigurationApi,
+    Configuration,
+    ApiOrganizations507f1f77bcf86cd799439055PutRequest
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ConfigurationApi(configuration);
+
+let apiOrganizations507f1f77bcf86cd799439055PutRequest: ApiOrganizations507f1f77bcf86cd799439055PutRequest; // (optional)
+
+const { status, data } = await apiInstance.apiCustomfields507f1f77bcf86cd799439150Put(
+    apiOrganizations507f1f77bcf86cd799439055PutRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **apiOrganizations507f1f77bcf86cd799439055PutRequest** | **ApiOrganizations507f1f77bcf86cd799439055PutRequest**|  | |
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: Not defined
+
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **apiCustomfieldsPost**
+> ApiCustomfieldsPost201Response apiCustomfieldsPost()
+
+Creates a new custom field for a given entity type.  ## Request Body  - `feature` (string, required): The entity this field belongs to. One of: `contact`, `prospect`, `lead`, `deal` - `name` (string, required): Display name of the custom field - `fieldType` (string, required): The ID of the field type (obtain from `GET /api/customFieldTypes`) - `values` (array): Predefined values for `enum` type fields. Each item: `{ \"value\": \"Option name\" }` - `settings` (object): Visibility and editability rules. Key sub-properties:   - `required` (boolean): Whether the field is mandatory   - `visibleOnView` (boolean): Whether shown in detail view   - `visibleOnViewWhen` (array): Lifecycle stages where visible (e.g., `[\"contact\", \"prospect\", \"lead\"]`)   - `editable` (boolean): Whether users can edit this field   - `editableWhen` (array): Lifecycle stages where editable   - `creatable` (boolean): Whether shown during entity creation   - `creatableWhen` (array): Lifecycle stages where shown at creation   - `deletable` (boolean): Whether the field can be deleted - `modules` (array): Modules where the field appears. Options: `rule`, `dashboard`, `report`, `form`  ## Response  Returns the created custom field object with `_id`, `slug`, and all configured properties.
+
+### Example
+
+```typescript
+import {
+    ConfigurationApi,
+    Configuration,
+    ApiCustomfieldsPostRequest
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ConfigurationApi(configuration);
+
+let apiCustomfieldsPostRequest: ApiCustomfieldsPostRequest; // (optional)
+
+const { status, data } = await apiInstance.apiCustomfieldsPost(
+    apiCustomfieldsPostRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **apiCustomfieldsPostRequest** | **ApiCustomfieldsPostRequest**|  | |
+
+
+### Return type
+
+**ApiCustomfieldsPost201Response**
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**201** | Create Custom Field |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **apiCustomfieldtypesGet**
+> apiCustomfieldtypesGet()
+
+Lista tipos de campos disponíveis (texto, numero, data, etc).
+
+### Example
+
+```typescript
+import {
+    ConfigurationApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ConfigurationApi(configuration);
+
+const { status, data } = await apiInstance.apiCustomfieldtypesGet();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **apiDealsLabels507f1f77bcf86cd799439160Delete**
+> apiDealsLabels507f1f77bcf86cd799439160Delete()
+
+Remove uma label.
+
+### Example
+
+```typescript
+import {
+    ConfigurationApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ConfigurationApi(configuration);
+
+const { status, data } = await apiInstance.apiDealsLabels507f1f77bcf86cd799439160Delete();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **apiDealsLabels507f1f77bcf86cd799439160Put**
+> apiDealsLabels507f1f77bcf86cd799439160Put()
+
+
+### Example
+
+```typescript
+import {
+    ConfigurationApi,
+    Configuration,
+    ApiDealsLabelsPostRequest
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ConfigurationApi(configuration);
+
+let apiDealsLabelsPostRequest: ApiDealsLabelsPostRequest; // (optional)
+
+const { status, data } = await apiInstance.apiDealsLabels507f1f77bcf86cd799439160Put(
+    apiDealsLabelsPostRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **apiDealsLabelsPostRequest** | **ApiDealsLabelsPostRequest**|  | |
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: Not defined
+
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **apiDealsLabelsGet**
+> apiDealsLabelsGet()
+
+Lista labels de oportunidades.
+
+### Example
+
+```typescript
+import {
+    ConfigurationApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ConfigurationApi(configuration);
+
+const { status, data } = await apiInstance.apiDealsLabelsGet();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **apiDealsLabelsPost**
+> apiDealsLabelsPost()
+
+
+### Example
+
+```typescript
+import {
+    ConfigurationApi,
+    Configuration,
+    ApiDealsLabelsPostRequest
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ConfigurationApi(configuration);
+
+let apiDealsLabelsPostRequest: ApiDealsLabelsPostRequest; // (optional)
+
+const { status, data } = await apiInstance.apiDealsLabelsPost(
+    apiDealsLabelsPostRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **apiDealsLabelsPostRequest** | **ApiDealsLabelsPostRequest**|  | |
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: Not defined
+
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **apiRolesGet**
+> ApiRolesGet200Response apiRolesGet()
+
+Lista perfis de acesso disponíveis.
+
+### Example
+
+```typescript
+import {
+    ConfigurationApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ConfigurationApi(configuration);
+
+const { status, data } = await apiInstance.apiRolesGet();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**ApiRolesGet200Response**
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | List Roles |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **apiStaffs507f1f77bcf86cd799439180Get**
+> ApiStaffs507f1f77bcf86cd799439180Get200Response apiStaffs507f1f77bcf86cd799439180Get()
+
+Retorna um usuario pelo ID.
+
+### Example
+
+```typescript
+import {
+    ConfigurationApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ConfigurationApi(configuration);
+
+const { status, data } = await apiInstance.apiStaffs507f1f77bcf86cd799439180Get();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**ApiStaffs507f1f77bcf86cd799439180Get200Response**
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Get Staff |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **apiStaffsGet**
+> ApiStaffsGet200Response apiStaffsGet()
+
+Lista usuarios do tenant.
+
+### Example
+
+```typescript
+import {
+    ConfigurationApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ConfigurationApi(configuration);
+
+let page: number; // (optional) (default to undefined)
+let limit: number; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.apiStaffsGet(
+    page,
+    limit
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **page** | [**number**] |  | (optional) defaults to undefined|
+| **limit** | [**number**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**ApiStaffsGet200Response**
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | List Staffs |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **apiTeams507f1f77bcf86cd799439190Get**
+> apiTeams507f1f77bcf86cd799439190Get()
+
+Retorna uma equipe pelo ID.
+
+### Example
+
+```typescript
+import {
+    ConfigurationApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ConfigurationApi(configuration);
+
+const { status, data } = await apiInstance.apiTeams507f1f77bcf86cd799439190Get();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **apiTeamsGet**
+> apiTeamsGet()
+
+Lista equipes do tenant.
+
+### Example
+
+```typescript
+import {
+    ConfigurationApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ConfigurationApi(configuration);
+
+const { status, data } = await apiInstance.apiTeamsGet();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **apiWorkspaces507f1f77bcf86cd799439170Get**
+> apiWorkspaces507f1f77bcf86cd799439170Get()
+
+Retrieves details of a specific workspace by ID. Returns `_id`, `name`, `slug`, `active`, `defaultForNewConversation`, `partner` (optional), `createdAt`, `updatedAt`.
+
+### Example
+
+```typescript
+import {
+    ConfigurationApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ConfigurationApi(configuration);
+
+const { status, data } = await apiInstance.apiWorkspaces507f1f77bcf86cd799439170Get();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **apiWorkspaces507f1f77bcf86cd799439170Put**
+> apiWorkspaces507f1f77bcf86cd799439170Put()
+
+
+### Example
+
+```typescript
+import {
+    ConfigurationApi,
+    Configuration,
+    ApiOrganizations507f1f77bcf86cd799439055PutRequest
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ConfigurationApi(configuration);
+
+let apiOrganizations507f1f77bcf86cd799439055PutRequest: ApiOrganizations507f1f77bcf86cd799439055PutRequest; // (optional)
+
+const { status, data } = await apiInstance.apiWorkspaces507f1f77bcf86cd799439170Put(
+    apiOrganizations507f1f77bcf86cd799439055PutRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **apiOrganizations507f1f77bcf86cd799439055PutRequest** | **ApiOrganizations507f1f77bcf86cd799439055PutRequest**|  | |
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: Not defined
+
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **apiWorkspacesGet**
+> ApiWorkspacesGet200Response apiWorkspacesGet()
+
+Returns a paginated list of workspaces (ticket queues) available in the account.  ## Query Parameters  - `page` (number, optional): Page number for pagination. Default: 1 - `search` (string, optional): Filter workspaces by name - `limit` (number, optional): Number of workspaces per page. Default: 15, max: 100  ## Response  - `docs` (array): List of workspace objects, each with:   - `_id` (string): Workspace ID   - `name` (string): Display name   - `slug` (string): URL-friendly identifier   - `active` (boolean): Whether the workspace is active   - `defaultForNewConversation` (boolean): Whether new tickets are assigned here by default   - `partner` (string, optional): Associated partner ID   - `createdAt` / `updatedAt` (string): ISO 8601 timestamps - `total` (number): Total number of workspaces - `limit` (number): Items per page - `page` (number): Current page - `pages` (number): Total pages
+
+### Example
+
+```typescript
+import {
+    ConfigurationApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ConfigurationApi(configuration);
+
+const { status, data } = await apiInstance.apiWorkspacesGet();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**ApiWorkspacesGet200Response**
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | List Workspaces |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **apiWorkspacesPost**
+> apiWorkspacesPost()
+
+
+### Example
+
+```typescript
+import {
+    ConfigurationApi,
+    Configuration,
+    ApiOrganizations507f1f77bcf86cd799439055PutRequest
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ConfigurationApi(configuration);
+
+let apiOrganizations507f1f77bcf86cd799439055PutRequest: ApiOrganizations507f1f77bcf86cd799439055PutRequest; // (optional)
+
+const { status, data } = await apiInstance.apiWorkspacesPost(
+    apiOrganizations507f1f77bcf86cd799439055PutRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **apiOrganizations507f1f77bcf86cd799439055PutRequest** | **ApiOrganizations507f1f77bcf86cd799439055PutRequest**|  | |
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: Not defined
+
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+