UserPluginsListResponse

User plugins list response

available object[]required

Plugins available for the user to enable

Array [

capabilities objectrequired

Plugin capabilities

readSyncbooleanrequired

Can sync reading progress

userRecommendationProviderbooleanrequired

Can provide recommendations

descriptionstring | nullnullable

Plugin description

displayNamestringrequired

Plugin display name

namestringrequired

Plugin name

oauthConfiguredbooleanrequired

Whether the admin has configured OAuth credentials (client_id set)

pluginIdstring<uuid>required

Plugin definition ID

requiresOauthbooleanrequired

Whether this plugin requires OAuth authentication

userSetupInstructionsstring | nullnullable

User-facing setup instructions for the plugin

]

enabled object[]required

Plugins the user has enabled

Array [

capabilities objectrequired

Plugin capabilities (derived from manifest)

readSyncbooleanrequired

Can sync reading progress

userRecommendationProviderbooleanrequired

Can provide recommendations

configrequired

Per-user configuration

connectedbooleanrequired

Whether the plugin is connected (has valid credentials/OAuth)

createdAtstring<date-time>required

Created timestamp

descriptionstring | nullnullable

User-facing description of the plugin

enabledbooleanrequired

Whether the user has enabled this plugin

externalAvatarUrlstring | nullnullable

External service avatar URL

externalUsernamestring | nullnullable

External service username (if connected via OAuth)

healthStatusstringrequired

Health status of this user's plugin instance

idstring<uuid>required

User plugin instance ID

lastSuccessAtstring,null<date-time>nullable

Last successful operation timestamp

lastSyncAtstring,null<date-time>nullable

Last sync timestamp

lastSyncResult

Last sync result summary (stored in user_plugin_data)

oauthConfiguredbooleanrequired

Whether the admin has configured OAuth credentials (client_id set)

pluginDisplayNamestringrequired

Plugin display name for UI

pluginIdstring<uuid>required

Plugin definition ID

pluginNamestringrequired

Plugin display name

pluginTypestringrequired

Plugin type: "system" or "user"

requiresOauthbooleanrequired

Whether this plugin requires OAuth authentication

userConfigSchema object

oneOf

• null
• ConfigSchemaDto

null

userSetupInstructionsstring | nullnullable

User-facing setup instructions for the plugin

]

UserPluginsListResponse

{
  "available": [
    {
      "capabilities": {
        "readSync": true,
        "userRecommendationProvider": true
      },
      "description": "string",
      "displayName": "string",
      "name": "string",
      "oauthConfigured": true,
      "pluginId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "requiresOauth": true,
      "userSetupInstructions": "string"
    }
  ],
  "enabled": [
    {
      "capabilities": {
        "readSync": true,
        "userRecommendationProvider": true
      },
      "connected": true,
      "createdAt": "2024-07-29T15:51:28.071Z",
      "description": "string",
      "enabled": true,
      "externalAvatarUrl": "string",
      "externalUsername": "string",
      "healthStatus": "string",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "lastSuccessAt": "2024-07-29T15:51:28.071Z",
      "lastSyncAt": "2024-07-29T15:51:28.071Z",
      "oauthConfigured": true,
      "pluginDisplayName": "string",
      "pluginId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "pluginName": "string",
      "pluginType": "string",
      "requiresOauth": true,
      "userConfigSchema": "null",
      "userSetupInstructions": "string"
    }
  ]
}