# PluginSetting

Type: object

Schema: [PluginSetting](https://sourcey-gauzy.pages.dev/api-reference/models/pluginsetting/index.md)

- `deletedAt` (optional)
  Type: string, date-time
  
  Example:
  
  ```json
  "2018-11-21T06:20:32.232Z"
  ```

- `createdAt` (optional)
  Type: string, date-time
  
  The creation timestamp of the entity.
  
  Example:
  
  ```json
  "2018-11-21T06:20:32.232Z"
  ```

- `updatedAt` (optional)
  Type: string, date-time
  
  The last update timestamp of the entity.
  
  Example:
  
  ```json
  "2018-11-21T06:20:32.232Z"
  ```

- `id` (optional)
  Type: string

- `isActive` (optional)
  Type: boolean
  
  default: true

- `isArchived` (optional)
  Type: boolean
  
  default: false

- `archivedAt` (optional)
  Type: string, date-time
  
  Example:
  
  ```json
  "2018-11-21T06:20:32.232Z"
  ```

- `tenantId` (optional)
  Type: string

- `organizationId` (optional)
  Type: string

- `key` (required)
  Type: string
  
  Setting key/name

- `value` (required)
  Type: string
  
  Setting value string

- `isRequired` (required)
  Type: boolean
  
  Whether the setting is required

- `isEncrypted` (required)
  Type: boolean
  
  Whether the setting is encrypted/sensitive

- `description` (optional)
  Type: string
  
  Setting description/help text

- `order` (optional)
  Type: number
  
  Display order for UI

- `validationRules` (optional)
  Type: string
  
  Validation rules (JSON string)

- `dataType` (required)
  Type: string
  
  Data type of the setting
  
  enum: ["string","number","boolean","json","file"]

- `defaultValue` (optional)
  Type: string
  
  Default value for the setting

- `pluginId` (required)
  Type: string
  
  Plugin ID

- `plugin` (optional)
  Type: unknown
  
  Plugin
  
  allOf:
    Reference: [Plugin_1](https://sourcey-gauzy.pages.dev/api-reference/models/plugin-1/index.md); Type: object

- `pluginTenantId` (optional)
  Type: string
  
  Plugin tenant ID for tenant-specific settings

- `pluginTenant` (optional)
  Type: unknown
  
  Plugin tenant
  
  allOf:
    Reference: [PluginTenant_1](https://sourcey-gauzy.pages.dev/api-reference/models/plugintenant-1/index.md); Type: object

- `categoryId` (optional)
  Type: string
  
  Plugin category ID for default category settings

- `category` (optional)
  Type: unknown
  
  Plugin category
  
  allOf:
    Reference: [PluginCategory](https://sourcey-gauzy.pages.dev/api-reference/models/plugincategory/index.md); Type: object

- `updatedBy` (optional)
  Type: unknown
  
  User who last updated this setting
  
  allOf:
    Reference: [User](https://sourcey-gauzy.pages.dev/api-reference/models/user/index.md); Type: object

- `updatedById` (optional)
  Type: string
  
  ID of the user who last updated this setting