PIpipeshub-ai
Connector Registry

List available connector types

Changed on

Get all available connector types from the registry.<br><br> <b>Overview:</b><br> The registry contains all connector types that can be configured as instances. Each type has specific authentication requirements, supported scopes, and capabilities.<br><br> <b>Connector Types Include:</b><br>

<ul> <li><b>Google Workspace:</b> Drive, Gmail, Calendar, etc.</li> <li><b>Microsoft 365:</b> OneDrive, Outlook, SharePoint, etc.</li> <li><b>Cloud Storage:</b> Dropbox, Box, AWS S3</li> <li><b>Collaboration:</b> Slack, Confluence, Notion, Jira</li> <li><b>Databases:</b> PostgreSQL, MySQL, MongoDB</li> </ul> <b>Filtering:</b><br> Use <code>scope</code> to filter by team or personal connectors. Use <code>search</code> for full-text search across connector names.
get/connectors/registry

Request

  • Base URL
    https://app.pipeshub.com/api/v1
  • URL
    https://app.pipeshub.com/api/v1/connectors/registry
  • 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:<br>

<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

Which connector types to list. Defaults to team.

pageinteger

Page number

limitinteger

Items per page

searchstring

Case-insensitive search across name, type, app group, description, auth types and categories. Every whitespace-separated word must match.

isAuthenticatedboolean

Validated (must be <code>true</code> or <code>false</code>) but ignored by this endpoint: it filters nothing. The parameter exists because the query validator is shared with <code>GET /connectors</code>.

isActiveboolean

Validated (must be <code>true</code> or <code>false</code>) but ignored by this endpoint: it filters nothing.

connectorTypestring

Validated (must not be empty or blank: the value is trimmed before it is checked) but ignored by this endpoint: it filters nothing.

Response

Connector registry retrieved

successboolean required

Example response

{
  "connectors": [
    {
      "name": "OneDrive",
      "type": "OneDrive",
      "appGroup": "Microsoft 365",
      "appCategories": [
        "Storage"
      ],
      "iconPath": "/icons/connectors/onedrive.svg",
      "documentationLinks": [
        {
          "title": "Azure AD App Registration Setup",
          "type": "setup"
        }
      ],
      "personalConnectorType": "Notion Personal",
      "scope": "team"
    }
  ]
}

Changes

  • dbb5e203b445Revision changes
    • info

      added the new optional query request parameter connectorType

    • info

      added the new optional query request parameter isActive

    • info

      added the new optional query request parameter isAuthenticated

    • info

      added the non-success response with the status

  • fc76aa045994Revision changes
    • 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