NIN Connect Docs
REST API

Plugins API

GET /api/v1/plugins — list active plugins with auth methods, tool counts, categories, and optional connection status.

List Plugins

GET /api/v1/plugins

Returns all active and approved plugins with their auth methods, tool counts, and categories. Only plugins with status = "active" and reviewStatus = "approved" are included — draft, pending, or declined plugins are never exposed through this endpoint.

Authentication

API key required: Authorization: Bearer nk_live_...

Query Parameters

ParameterTypeRequiredDescription
userIdstringNoIf provided, includes connected: true/false for this user
limitnumberNoEnables pagination and returns up to this many plugins. Maximum: 100
cursorstringNoOpaque cursor from the previous response
connectedFirstbooleanNoWhen true and userId is provided, connected plugins are sorted first

Response

{
  "plugins": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "slug": "gmail",
      "name": "Gmail",
      "description": "Send and manage emails via Gmail API",
      "iconUrl": "https://example.com/gmail-icon.png",
      "pluginPrompt": "When using Gmail tools, always confirm the recipient before sending.",
      "status": "active",
      "authMethods": [
        {
          "type": "oauth2",
          "label": "Google OAuth",
          "isDefault": true
        }
      ],
      "categories": [
        { "slug": "messaging", "name": "Messaging" }
      ],
      "toolCount": 5,
      "connected": true
    }
  ],
  "nextCursor": "eyJvZmZzZXQiOjMwfQ",
  "hasMore": true
}

Response Fields

FieldTypeDescription
idstringPlugin UUID
slugstringUnique identifier used in SDK calls
namestringDisplay name
descriptionstring or nullPlugin description
iconUrlstring or nullIcon URL
pluginPromptstring or nullOptional LLM context prompt
statusstringAlways "active" (only active, approved plugins are returned)
authMethodsarrayAvailable auth methods with type, label, and default flag
categoriesarrayCategory slugs and names
toolCountnumberCount of enabled tools
connectedbooleanOnly present when userId is provided
nextCursorstring or nullCursor for the next page when limit is used
hasMorebooleanWhether another page is available

On this page