Agents23

AI Models Providers1

Connector3

Connector Configuration4

Connector Control1

Connector Filters3

Connector Instances7

Connector OAuth2

Connector Registry4

Conversations18

Knowledge Base23

OAuth Apps11

OAuth Configuration8

OAuth Provider3

OpenID Connect1

Organization Auth Config3

Organizations1

Personal Access Tokens6

Semantic Search8

User Account6

Web Search1

Connector Instances

List connector instances

Changed on Oct 28, 2026

Get all configured connector instances for your organization. Overview: Returns instances created by users, filtered by scope and permissions. Team-scope connectors are visible to all org users. Personal connectors are only visible to their creators, not even to admins. Knowledge bases (instances of type <code>KB</code>) are not listed here. Instance States:

<ul> <li>isConfigured: All required settings are complete</li> <li>isAuthenticated: OAuth flow complete or credentials valid</li> <li>isActive: Connector is enabled for sync/agent</li> <li>desktopOnline: Owner device's desktop app connected (Local FS only)</li> <li>ownerDeviceId / ownerDeviceName: Desktop device that owns the connector, set on first enable (Local FS only)</li> </ul>

get/connectors

Request

Base URL
https://app.pipeshub.com/api/v1
URL
https://app.pipeshub.com/api/v1/connectors
Auth
- HTTP bearer
- or OAuth 2
  Authorization code: /api/v1/oauth2/authorize
  Client credentials
  Token URL: /api/v1/oauth2/token scopes: connector:read

Query parameters

scope'team' | 'personal'

Scope determines visibility and access control for connectors:

<ul> <li><code>team</code> - Available to all users in the organization (admin-only creation)</li> <li><code>personal</code> - Private to the creating user only</li> </ul>

Example:team

Filter by scope. Defaults to <code>team</code> when omitted.

pageinteger

Page number, 1-based

limitinteger

Items per page

searchstring

Full-text search across instance name, type, and app group. The term is not echoed back in <code>pagination</code>.

isAuthenticatedboolean

Filter by authentication status. <code>true</code> returns only authenticated instances; <code>false</code> returns only unauthenticated ones. Omit to return all.

isActiveboolean

Filter by active status. <code>true</code> returns only active instances; <code>false</code> returns only inactive ones. Omit to return all.

connectorTypestring

Filter by exact connector type string (e.g. <code>Confluence</code>, <code>GoogleDrive</code>). Case-sensitive. An empty or blank value is refused with 400 (the value is trimmed before it is checked).

Response

Instances retrieved

successboolean required

Example response

{
  "connectors": [
    {
      "_key": "7b387394-1248-4fb6-810d-e8ac9ac226eb",
      "name": "Company Google Drive",
      "type": "Drive Workspace",
      "documentationLinks": [
        {
          "title": "Azure AD App Registration Setup",
          "type": "setup"
        }
      ],
      "authType": "OAUTH",
      "scope": "team",
      "status": "IDLE",
      "config": {
        "documentationLinks": [
          {
            "title": "Azure AD App Registration Setup",
            "type": "setup"
          }
        ],
        "sync": {
          "scheduledConfig": {
            "timezone": "UTC"
          },
          "realtimeConfig": {
            "connectionType": "WEBSOCKET"
          }
        }
      }
    }
  ]
}

Changes

Oct 28, 2026dbb5e203b445 Revision changes
- breaking
  added the pattern \S to the query request parameter connectorType
- breaking
  the response property // became nullable for the status
- breaking
  the response property // became nullable for the status
- breaking
  the response property // became nullable for the status
- breaking
  the response property // became nullable for the status
- warning
  added the new APP_LEVEL enum value to the /// response property for the response status
- warning
  added the new RECORD_LEVEL enum value to the /// response property for the response status
- info
  added the non-success response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property //////// to the response with the status
- info
  added the optional property //////// to the response with the status
- info
  removed the ACCESS_KEY enum value from the // response property for the response status
- info
  removed the ACCOUNT_KEY enum value from the // response property for the response status
- info
  removed the API_TOKEN enum value from the // response property for the response status
- info
  removed the BASIC_AUTH enum value from the // response property for the response status
- info
  removed the BEARER_TOKEN enum value from the // response property for the response status
- info
  removed the CONNECTION_STRING enum value from the // response property for the response status
- info
  removed the CUSTOM enum value from the // response property for the response status
- info
  removed the ENTRA_ID enum value from the // response property for the response status
- info
  removed the IAM_ROLE enum value from the // response property for the response status
- info
  removed the NONE enum value from the // response property for the response status
- info
  removed the OAUTH enum value from the // response property for the response status
- info
  removed the OAUTH_ADMIN_CONSENT enum value from the // response property for the response status
Oct 26, 2026fc76aa045994 Revision changes
- warning
  added the new ENTRA_ID enum value to the // response property for the response status
- warning
  added the new ENTRA_ID enum value to the ///// response property for the response status
- warning
  added the new ENTRA_ID enum value to the /// response property for the response status
- warning
  added the new IAM_ROLE enum value to the // response property for the response status
- warning
  added the new IAM_ROLE enum value to the ///// response property for the response status
- warning
  added the new IAM_ROLE enum value to the /// response property for the response status

Operation history (4 revisions)