Connectors

Connections

Connections loads the catalog. The request sends no filter. This workspace has not connected any of them, so every one is disconnected.

get/v1/connectors

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /v1/connectors
  • Auth: HTTP bearer

Response

Every connection is disconnected.

Example response

{
  "connectors": [
    {
      "audience": "canvas-api",
      "authType": "oauth",
      "availableScopes": [
        {
          "conflictsWith": [
            "canvas:payments.readonly"
          ],
          "description": "View invoice balances and status.",
          "displayName": "Read invoices",
          "environments": [
            "production"
          ],
          "grantTier": "required",
          "implies": [
            "canvas:customers.read"
          ],
          "name": "canvas:invoices.read",
          "requiredPlan": "pro",
          "risk": "low"
        }
      ],
      "connected": true,
      "connectedAt": "2026-06-04T20:38:00Z",
      "connectionHealth": "healthy",
      "connectionReason": "reauth_required",
      "description": "Banking, invoicing, dunning, transactions",
      "displayName": "Canvas",
      "grantedScopes": [
        {
          "conflictsWith": [
            "canvas:payments.readonly"
          ],
          "description": "View invoice balances and status.",
          "displayName": "Read invoices",
          "environments": [
            "production"
          ],
          "grantTier": "required",
          "implies": [
            "canvas:customers.read"
          ],
          "name": "canvas:invoices.read",
          "requiredPlan": "pro",
          "risk": "low"
        }
      ],
      "health": "healthy",
      "iconUrl": "https://example.com/icon.png",
      "lastUsedAt": "2026-06-04T20:45:00Z",
      "mcpTools": [
        {
          "name": "customer.lookup",
          "trustTier": "read"
        }
      ],
      "mcpUrl": "https://api.canvas.solomon-ai.co/v1/mcp",
      "name": "canvas",
      "nativeTools": [
        {
          "name": "customer.lookup",
          "trustTier": "read"
        }
      ],
      "revokedAt": "2026-06-04T20:50:00Z",
      "status": "active",
      "templateBlocks": [
        {
          "category": "finance",
          "description": "Look up invoices, customers, balances, and current payment status.",
          "id": "invoice-context",
          "mcpTools": [
            "invoice.lookup"
          ],
          "nativeTools": [
            "connector.read.hubspot_search"
          ],
          "requiredScopes": [
            "invoices:read"
          ],
          "samplePrompt": "Show me the current invoice status for Acme.",
          "title": "Invoice context",
          "trustTier": "read"
        }
      ],
      "transport": "mcp"
    }
  ]
}

Changes

No recorded changes to this operation across all 50 revisions of this API.